cURL
curl --request GET \
--url 'https://api.forecast.example/api/v1/ticks?symbol=KXBTCD-26JUN1420&limit=500' \
--header 'Authorization: Bearer YOUR_API_KEY'
const response = await fetch(
'https://api.forecast.example/api/v1/ticks?symbol=KXBTCD-26JUN1420&limit=500',
{
headers: {
Authorization: 'Bearer YOUR_API_KEY'
}
}
);
const data = await response.json();
import requests
data = requests.get(
"https://api.forecast.example/api/v1/ticks",
params={"symbol": "KXBTCD-26JUN1420", "limit": 500},
headers={"Authorization": "Bearer YOUR_API_KEY"},
timeout=30,
).json()
{
"symbol": "KXBTCD-26JUN1420",
"ticks": [
{ "t": 1719705600123, "p": 0.52 },
{ "t": 1719705601123, "p": 0.53 }
],
"count": 2,
"from": 1719705600000,
"to": 1719709200000,
"generated_at": 1719709201000
}
Realtime Data
Get tick history
GET
/
api
/
v1
/
ticks
cURL
curl --request GET \
--url 'https://api.forecast.example/api/v1/ticks?symbol=KXBTCD-26JUN1420&limit=500' \
--header 'Authorization: Bearer YOUR_API_KEY'
const response = await fetch(
'https://api.forecast.example/api/v1/ticks?symbol=KXBTCD-26JUN1420&limit=500',
{
headers: {
Authorization: 'Bearer YOUR_API_KEY'
}
}
);
const data = await response.json();
import requests
data = requests.get(
"https://api.forecast.example/api/v1/ticks",
params={"symbol": "KXBTCD-26JUN1420", "limit": 500},
headers={"Authorization": "Bearer YOUR_API_KEY"},
timeout=30,
).json()
{
"symbol": "KXBTCD-26JUN1420",
"ticks": [
{ "t": 1719705600123, "p": 0.52 },
{ "t": 1719705601123, "p": 0.53 }
],
"count": 2,
"from": 1719705600000,
"to": 1719709200000,
"generated_at": 1719709201000
}
cURL
curl --request GET \
--url 'https://api.forecast.example/api/v1/ticks?symbol=KXBTCD-26JUN1420&limit=500' \
--header 'Authorization: Bearer YOUR_API_KEY'
const response = await fetch(
'https://api.forecast.example/api/v1/ticks?symbol=KXBTCD-26JUN1420&limit=500',
{
headers: {
Authorization: 'Bearer YOUR_API_KEY'
}
}
);
const data = await response.json();
import requests
data = requests.get(
"https://api.forecast.example/api/v1/ticks",
params={"symbol": "KXBTCD-26JUN1420", "limit": 500},
headers={"Authorization": "Bearer YOUR_API_KEY"},
timeout=30,
).json()
{
"symbol": "KXBTCD-26JUN1420",
"ticks": [
{ "t": 1719705600123, "p": 0.52 },
{ "t": 1719705601123, "p": 0.53 }
],
"count": 2,
"from": 1719705600000,
"to": 1719709200000,
"generated_at": 1719709201000
}
Query parameters
string
required
Symbol to query. This endpoint requires exactly one symbol.
number
Optional start time in epoch milliseconds. Defaults to the trailing 24-hour window.
number
Optional end time in epoch milliseconds. Defaults to now.
number
default:2000
Maximum number of tick points returned after downsampling.
Response fields
string
required
Symbol used to generate the tick window.
object[]
required
Array of tick objects with time and price.
number
required
Number of tick objects returned.
number
required
Effective lower bound in epoch milliseconds.
number
required
Effective upper bound in epoch milliseconds.
number
required
Epoch milliseconds when the response was generated.