API Documentation

Authentication

Endpoints marked with Authentication required need authentication via the apiKey parameter. Add ?apiKey=YOUR_API_KEY to the request URL. You can generate an API key in your profile settings.

Rate Limits

API requests are limited to 10 requests per second and 100 requests per minute. If you exceed these limits, additional requests will be blocked until the limit resets.

GET /api/v1/assets

Get a list of all available cryptocurrencies

Example Response

[ {
  "symbol" : "BTC",
  "name" : "Bitcoin"
}, {
  "symbol" : "ETH",
  "name" : "Ethereum"
} ]

GET /api/v1/candles

Get current candle data for specified assets and timeframes

Parameters

Name	Type	Required	Description
`assets`	string	No	Comma-separated list of asset symbols (e.g., BTC,ETH)
`timeframe`	string	No	Candle timeframe (e.g., H1 for hourly candles) Default value `H1` Allowed values `H1, H4, D1`

Example Response

[ {
  "asset" : "BTC",
  "timeframe" : "H1",
  "timestamp" : "2024-06-01T12:00:00Z",
  "open" : 30000.0,
  "high" : 30500.0,
  "low" : 29500.0,
  "close" : 30200.0,
  "volume" : 150.0,
  "amount" : 4500000.0,
  "trades" : 1200
} ]

GET /api/v1/candles/history Auth Required

Get historical candle data for a specific asset (requires authentication)

Parameters

Name	Type	Required	Description
`asset`	string	Yes	Asset symbol (e.g., BTC)
`timeframe`	string	Yes	Candle timeframe (e.g., H1 for hourly candles) Default value `H1` Allowed values `H1, H4, D1`
`limit`	integer	No	Maximum number of records to return Default value `100` Allowed range 1 - 1000

Example Response

[ {
  "asset" : "BTC",
  "timeframe" : "H1",
  "timestamp" : "2024-06-01T12:00:00Z",
  "open" : 30000.0,
  "high" : 30500.0,
  "low" : 29500.0,
  "close" : 30200.0,
  "volume" : 150.0,
  "amount" : 4500000.0,
  "trades" : 1200
} ]

GET /api/v1/indicators

Get a list of all available indicator definitions

Example Response

[ {
  "name" : "EMA_200",
  "category" : "TREND_MA"
}, {
  "name" : "KAMA_20",
  "category" : "TREND_MA"
}, {
  "name" : "MACD_12_26_9",
  "category" : "MOMENTUM"
} ]

GET /api/v1/indicators/values Auth Required

Get current indicator values for specified assets and timeframes

Parameters

Name	Type	Required	Description
`assets`	string	No	Comma-separated list of asset symbols (e.g., BTC,ETH)
`timeframe`	string	No	Candle timeframe (e.g., H1 for hourly candles) Default value `H1` Allowed values `H1, H4, D1`

Example Response

[ {
  "asset" : "BTC",
  "timeframe" : "D1",
  "timestamp" : "2025-12-22T00:00:00Z",
  "indicator" : "EMA_200",
  "value" : 104372.85442427166
}, {
  "asset" : "BTC",
  "timeframe" : "D1",
  "timestamp" : "2025-12-22T00:00:00Z",
  "indicator" : "KAMA_20",
  "value" : 90424.25875177557
}, {
  "asset" : "BTC",
  "timeframe" : "D1",
  "timestamp" : "2025-12-22T00:00:00Z",
  "indicator" : "MACD_12_26_9",
  "value" : -847.4341762754582
} ]

GET /api/v1/indicators/values/history Auth Required

Get historical indicator values for a specific asset (requires authentication)

Parameters

Name	Type	Required	Description
`asset`	string	Yes	Asset symbol (e.g., BTC)
`timeframe`	string	Yes	Candle timeframe (e.g., H1 for hourly candles) Default value `H1` Allowed values `H1, H4, D1`
`indicators`	string	No	Comma-separated list of indicator names (e.g., RSI_14,MACD)
`limit`	integer	No	Maximum number of records to return Default value `10` Allowed range 1 - 100

Example Response

[ {
  "asset" : "BTC",
  "timeframe" : "H1",
  "timestamp" : "2025-12-23T02:00:00Z",
  "indicator" : "EMA_20",
  "value" : 88884.06800565078
}, {
  "asset" : "BTC",
  "timeframe" : "H1",
  "timestamp" : "2025-12-23T03:00:00Z",
  "indicator" : "EMA_20",
  "value" : 88808.69162554297
}, {
  "asset" : "BTC",
  "timeframe" : "H1",
  "timestamp" : "2025-12-23T04:00:00Z",
  "indicator" : "EMA_20",
  "value" : 88732.89818220086
} ]

GET /api/v1/models

Get a list of all available machine learning models

Example Response

[ {
  "name" : "random-forest-balanced",
  "active" : true
}, {
  "name" : "xg-boost-balanced",
  "active" : false
}, {
  "name" : "random-forest-aggressive",
  "active" : true
}, {
  "name" : "xg-boost-aggressive",
  "active" : false
} ]

GET /api/v1/news Auth Required

Get latest news articles, optionally filtered by assets (requires authentication)

Parameters

Name	Type	Required	Description
`assets`	string	No	Comma-separated list of asset symbols (e.g., BTC,ETH)
`limit`	integer	No	Maximum number of records to return Default value `10` Allowed range 1 - 100

Example Response

[ {
  "title" : "IMF advances talks with El Salvador on Bitcoin policy and Chivo wallet future.",
  "link" : "https://coinjournal.net/news/imf-advances-talks-with-el-salvador-on-bitcoin-policy-and-chivo-wallet-future",
  "publishedAt" : "2025-12-23T12:18:56Z",
  "sentimentScore" : 0.7864451361820102,
  "asset" : "BTC",
  "rssFeed" : "CoinJournal"
}, {
  "title" : "Are altcoins coming back? Why 'Bitcoin season' has staying power in 2026.",
  "link" : "https://cointelegraph.com/news/are-altcoins-coming-back-why-bitcoin-season-has-staying-power-in-2026",
  "publishedAt" : "2025-12-23T12:15:00Z",
  "sentimentScore" : 0.10285555198788643,
  "asset" : "BTC",
  "rssFeed" : "Cointelegraph"
} ]

GET /api/v1/predictions Auth Required

Get latest predictions from machine learning models, optionally filtered by assets and model (requires authentication)

Parameters

Name	Type	Required	Description
`assets`	string	No	Comma-separated list of asset symbols (e.g., BTC,ETH)
`model`	string	No	Model name (e.g., xg-boost-balanced)
`timeframe`	string	No	Candle timeframe (e.g., H1 for hourly candles) Default value `H1` Allowed values `H1, H4, D1`
`limit`	integer	No	Maximum number of records to return Default value `10` Allowed range 1 - 100

Example Response

[ {
  "asset" : "BTC",
  "timeframe" : "H1",
  "timestamp" : "2025-12-23T10:30:00Z",
  "model" : "random-forest-balanced",
  "signal" : "BUY",
  "score" : 0.85
}, {
  "asset" : "ETH",
  "timeframe" : "H1",
  "timestamp" : "2025-12-23T10:30:00Z",
  "model" : "random-forest-balanced",
  "signal" : "HOLD",
  "score" : 0.62
} ]

GET /api/v1/signals Auth Required

Get latest trading signals, optionally filtered by assets and model (requires authentication)

Parameters

Name	Type	Required	Description
`assets`	string	No	Comma-separated list of asset symbols (e.g., BTC,ETH)
`model`	string	No	Model name (e.g., xg-boost-balanced)
`limit`	integer	No	Maximum number of records to return Default value `10` Allowed range 1 - 100

Example Response

[ {
  "asset" : "BTC",
  "model" : "random-forest-balanced",
  "timestamp" : "2025-12-23T12:00:00Z",
  "signal" : "SELL"
}, {
  "asset" : "BTC",
  "model" : "random-forest-balanced",
  "timestamp" : "2025-12-23T11:00:00Z",
  "signal" : "HOLD"
}, {
  "asset" : "BTC",
  "model" : "random-forest-balanced",
  "timestamp" : "2025-12-23T10:00:00Z",
  "signal" : "HOLD"
} ]