Implement Currencies Endpoint
reubenwong97 opened this issue · comments
Description:
Using the
currencies
API endpoint you will be able to look up all currencies supported by the marketstack API.
HTTP Get Request Parameters:
Object | Description |
---|---|
access_key | [Required] Specify your API access key, available in your account dashboard. |
limit | [Optional] Specify a pagination limit (number of results per page) for your API request. Default limit value is 100, maximum allowed limit value is 1000. |
offset | [Optional] Specify a pagination offset value for your API request. Example: An offset value of 100 combined with a limit value of 10 would show results 100-110. Default value is 0, starting with the first available result. |
API Response:
{
"pagination": {
"limit": 100,
"offset": 0,
"count": 40,
"total": 40
},
"data": [
{
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"symbol_native": "$",
},
[...]
]
}
API Response Objects
Response Object | Description |
---|---|
pagination > limit | Returns your pagination limit value. |
pagination > offset | Returns your pagination offset value. |
pagination > count | Returns the results count on the current page. |
pagination > total | Returns the total count of results available. |
code | Returns the 3-letter code of the given currency. |
name | Returns the name of the given currency. |
symbol | Returns the text symbol of the given currency. |
symbol_native | Returns the native text symbol of the given currency. |
Note that symbol_native
seems to have been dropped from the API response.