GET
/v2/snapshot/locale/global/markets/forex/{direction}
Forex Top Market Movers
Top 20 forex gainers/losers snapshot.
Endpoint Details
| HTTP Method |
GET |
| Path |
/v2/snapshot/locale/global/markets/forex/{direction} |
| Version |
v2 |
| Minimum Plan |
free |
Path Parameters
| Parameter |
Required |
Description |
Example |
direction |
Required |
Direction for market movers (gainers or losers) |
gainers |
Query Parameters
| Parameter |
Type |
Required |
Description |
api_key |
string |
Required |
Your API key for authentication |
limit |
integer |
Optional
|
Maximum number of results to return |
sort |
string |
Optional
|
Sort order (asc or desc) |
Example Request
curl "https://mail.tradeiqai.com/api/v2/snapshot/locale/global/markets/forex/gainers?api_key=YOUR_API_KEY"
Note: Replace YOUR_API_KEY with your actual API key.
Response Attributes
| Attribute |
Type |
Description |
ok | boolean | Indicates if the request was successful (e.g., 1) |
data | object | Response data object |
data.status | string | Response status (typically "OK") (e.g., OK) |
data.results | object|array | Empty array |
Example Response
{
"ok": true,
"data": {
"status": "OK",
"direction": "gainers",
"count": 0,
"results": []
}
}