GET
/v2/aggs/ticker/{forexTicker}/range/{multiplier}/{timespan}/{from}/{to}
Forex Aggregates (Custom Bars)
Aggregated OHLCV bars for a forex pair over a custom range.
Endpoint Details
| HTTP Method |
GET |
| Path |
/v2/aggs/ticker/{forexTicker}/range/{multiplier}/{timespan}/{from}/{to} |
| Version |
v2 |
| Minimum Plan |
free |
Path Parameters
| Parameter |
Required |
Description |
Example |
forexTicker |
Required |
The forex pair ticker symbol (e.g., C:EURUSD) |
C:EURUSD |
multiplier |
Required |
The size of the timespan multiplier |
1 |
timespan |
Required |
The size of the aggregate time window (minute, hour, day, week, month, quarter, year) |
day |
from |
Required |
Source currency code (e.g., USD) |
USD |
to |
Required |
Target currency code (e.g., EUR) |
EUR |
Query Parameters
| Parameter |
Type |
Required |
Description |
api_key |
string |
Required |
Your API key for authentication |
adjusted |
boolean |
Optional
|
Whether aggregates are adjusted for splits (default: true) |
sort |
string |
Optional
|
Sort order (asc or desc, default: asc) |
limit |
integer |
Optional
|
Maximum number of results (default: 5000, max: 50000) |
Example Request
curl "https://mail.tradeiqai.com/api/v2/aggs/ticker/C:EURUSD/range/1/day/USD/EUR?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 |
data.status |
string |
The status of the request response (typically "OK") |
data.request_id |
string |
A unique request ID assigned by the server |
data.results |
object|array |
Object or array containing endpoint-specific data |
data.next_url |
string (optional) |
URL for pagination to fetch the next page of results |
Example Response
{
"ok": true,
"data": {
"status": "OK",
"request_id": "abc123def456...",
"results": {
// Endpoint-specific data structure
},
"next_url": "https://api.tradeiqai.com/...?cursor=xyz789"
}
}