Skip to content

Intervals

Get available time intervals for historical data from the current broker.

Endpoint URL

http
Local Host   :  POST http://127.0.0.1:5000/api/v1/intervals
Ngrok Domain :  POST https://<your-ngrok-domain>.ngrok-free.app/api/v1/intervals
Custom Domain:  POST https://<your-custom-domain>/api/v1/intervals

Sample API Request

json
{
  "apikey": "<your_app_apikey>"
}

Sample cURL Request

bash
curl -X POST http://127.0.0.1:5000/api/v1/intervals \
  -H 'Content-Type: application/json' \
  -d '{
  "apikey": "<your_app_apikey>"
}'

Sample API Response

json
{
  "status": "success",
  "data": {
    "months": [],
    "weeks": [],
    "days": ["D"],
    "hours": ["1h"],
    "minutes": ["1m", "3m", "5m", "10m", "15m", "30m"],
    "seconds": []
  }
}

Request Body

ParameterDescriptionMandatory/OptionalDefault Value
apikeyYour Tradeboard API keyMandatory-

IntervalsSchema declares only apikey. Any other field returns HTTP 400.

Response Fields

FieldTypeDescription
statusstring"success" or "error"
dataobjectAvailable intervals by category

Data Object Fields

FieldTypeDescription
monthsarrayMonthly intervals (e.g., "M")
weeksarrayWeekly intervals (e.g., "W")
daysarrayDaily intervals (e.g., "D")
hoursarrayHourly intervals (e.g., "1h", "2h")
minutesarrayMinute intervals (e.g., "1m", "5m", "15m")
secondsarraySecond intervals (e.g., "1s")

Common Interval Values

IntervalDescription
1m1 minute
3m3 minutes
5m5 minutes
10m10 minutes
15m15 minutes
30m30 minutes
1h1 hour
DDaily
WWeekly
MMonthly

The full set that /history will accept at the schema level is larger than this. What a given broker returns here is the subset it can actually serve.

Notes

  • Available intervals vary by broker
  • Always check available intervals before requesting History
  • Some brokers may not support all interval types
  • The response shows only intervals supported by your connected broker

Back to: API Documentation