> For the complete documentation index, see [llms.txt](https://ipforensics.gitbook.io/ipforensics/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ipforensics.gitbook.io/ipforensics/api/exchange-rate-api/currency-conversion-endpoint.md).

# Currency Conversion Endpoint

Using the `convert` endpoint, you may request the IpForensics API to perform a Single currency conversion on your behalf. e.g converting `$500 Dollars to Naira`

To use this endpoint, simply specify a `from` currency code, a `to` Currency Code, and the `amount` you would like to convert.

{% hint style="success" %}
Each request to the currency conversion endpoint consumes 1 token.
{% endhint %}

### Code Snippet

{% tabs %}
{% tab title="PHP Curl" %}

```javascript
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://ipforensics.net/api/v1/currency/convert?apikey=IPF-36ae36a6-4a32-4fae-a422-e45e70b0a515-X&from=USD&to=NGN&amount=500',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

```

{% endtab %}

{% tab title="Javascript" %}

```javascript
var requestOptions = {
  method: 'POST',
  redirect: 'follow'
};

fetch("https://ipforensics.net/api/v1/currency/convert?apikey=IPF-36ae36a6-4a32-4fae-a422-e45e70b0a515-X&from=USD&to=NGN&amount=500", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
```

{% endtab %}

{% tab title="Node Js" %}

```javascript
var axios = require('axios');

var config = {
  method: 'post',
  url: 'https://ipforensics.net/api/v1/currency/convert?apikey=IPF-36ae36a6-4a32-4fae-a422-e45e70b0a515-X&from=USD&to=NGN&amount=500',
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

```

{% endtab %}

{% tab title="Python" %}

```python
import requests

url = "https://ipforensics.net/api/v1/currency/convert?apikey=IPF-36ae36a6-4a32-4fae-a422-e45e70b0a515-X&from=USD&to=NGN&amount=500"

payload={}

response = requests.request("POST", url, data=payload)

print(response.text)

```

{% endtab %}

{% tab title="C#" %}

```csharp
var client = new RestClient("https://ipforensics.net/api/v1/currency/convert?apikey=IPF-36ae36a6-4a32-4fae-a422-e45e70b0a515-X&from=USD&to=NGN&amount=500");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
```

{% endtab %}
{% endtabs %}

### Sample Response

```javascript
{
    "status": true,
    "code": 200,
    "message": "Successful",
    "meta_data": {
        "from": "usd",
        "to": "ngn",
        "amount": "500",
        "exchange_rate": "220,315.02"
    }
}
```

### Endpoint

## Returns the converted currency.

<mark style="color:blue;">`GET`</mark> `https://ipforensics.net`

Returns response object and a metadata of the request

#### Query Parameters

| Name                                     | Type   | Description                           |
| ---------------------------------------- | ------ | ------------------------------------- |
| apikey<mark style="color:red;">\*</mark> | String | Your API key                          |
| from<mark style="color:red;">\*</mark>   | String | Specify the currency to convert from. |
| to<mark style="color:red;">\*</mark>     | String | Specify the currency to convert to.   |
| amount<mark style="color:red;">\*</mark> | String | Specify the amount to convert.        |

{% tabs %}
{% tab title="200: OK " %}

```javascript
{
    "status": true,
    "code": 200,
    "message": "Successful",
    "meta_data": {
        "from": "usd",
        "to": "ngn",
        "amount": "500",
        "exchange_rate": "220,315.02"
    }
}
```

{% endtab %}
{% endtabs %}