Skip to main content
POST
/
market-data
/
candles
Get Candles
curl --request POST \
  --url http://localhost:8000/market-data/candles \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connector_name": "<string>",
  "trading_pair": "<string>",
  "interval": "1m",
  "max_records": 500
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

The CandlesConfig class is a data class that stores the configuration of a Candle object. It has the following attributes:

  • connector: str
  • trading_pair: str
  • interval: str
  • max_records: int
​
connector_name
string
required
​
trading_pair
string
required
​
interval
string
default:1m
​
max_records
integer
default:500

Response

Successful Response