Documentation
Documentation of our currencies conversions API

Introduction

Welcome to Api Forex. we will explain here how to use it

Authentication

Daily rates

formatstringTruejson, xml, csv, protoFree, Gold, Silver, Gold
keystringFalseFree, Gold, Silver, Gold
sourcestringTrueSilver, Gold

Request

GET https://v1.api.forex/daily-rate.{format}?key={YourKey}

Response

{
  "terms": "https://api.forex/terms",
  "privacy": null,
  "timestamp": 12345,
  "source": "USD",
  "rates": {
    "AED": 3.6728,
    "ALL": 109.800003,
    "ANG": 1.78,
    "AOA": 183.466995,
    /* ... */
    "XPF": 97.800003,
    "XPT": 0.000998,
    "YER": 249.949997,
    "ZAR": 12.4132
  }
}

Usages limits

FreeStandardSilverGold
Quotas 100,0001,000,000UnlimitedUnlimited
Updates OKOKOKOK
/daily-rate KOKOOKOK

Historics rates

formatstringTruejson, xml, csv, protoFree, Gold, Silver, Gold
keystringFalseFree, Gold, Silver, Gold
sourcestringTrueSilver, Gold

Request

GET https://v1.api.forex/historic.{format}?key={YourKey}

Usages limits

FreeStandardSilverGold
Quotas 100,0001,000,000UnlimitedUnlimited
Updates OKOKOKOK
/daily-rate KOKOOKOK

Currencies infos

Quotas

FreeStandardSilverGold
Quotas UnlimitedUnlimitedUnlimitedUnlimited
Updates1 hour30 minues10 minutes5 seconds

Errors

Response


{
  "success": false,
  "error": {
    "code": 201,
    "message": "User entered an invalid access key."    
  }
}

Error codes

CodeMessageDescription
201
Bad RequestYou have entered an invalid access key.
202
Bad RequestYou have exceeded your request quota
400
Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further. Requests without authentication are considered invalid and will yield this response.
401
UnauthorizedMissing or incorrect authentication credentials. This may also returned in other undefined circumstances.
403
ForbiddenThe request is understood, but it has been refused or access is not allowed. An accompanying error message will explain why. This code is used when requests are being denied due to update limits . Other reasons for this status being returned are listed alongside the error codes in the table below.
404
Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist.
406
Not AcceptableReturned when an invalid format is specified in the request.
407
Not AcceptableInvalid currency code is specified in the request.
408
No DataThere is no data for the specified request.
410
GoneThis resource is gone. Used to indicate that an API endpoint has been turned off.
413
Request Entity Too LargeThe request is larger than the server is willing or able to process.
420
Enhance Your CalmReturned when an application is being rate limited for making too many requests.
429
Too Many RequestsReturned when a request cannot be served due to the application’s rate limit having been exhausted for the resource. See Rate Limiting.
500
Internal Server ErrorSomething is broken. This is usually a temporary error, for example in a high load situation or if an endpoint is temporarily having issues. Check in the developer forums in case others are having similar issues, or try again later.
502
Bad GatewayThe server API is down, or being upgraded.