Honeycluster Docs – Get OHLCV candles for a trade pair

trades

Get OHLCV candles for a trade pair

get

/trade/ohlcv

operationId: trade-ohlcv

Returns OHLCV candles for a single trade pair by its internal UUID. interval defaults to 1h (accepts 1m | 3m | 5m | 15m | 30m | 1h | 2h | 4h | 6h | 12h | 1d | 3d | 1w | 1M). startTime and endTime are Unix-seconds timestamps; when omitted, endTime falls back to the current server time and startTime falls back to endTime − (interval × limit) so a bare request always returns a limit-sized window ending at now. limit caps the number of candles returned (1–1000, default 500).

Authorizations

Name	Location	Details
`BearerAuth`	Authorization header · bearer	JWT issued by the Honeycluster auth service for the `indexer` audience. Present as `Authorization: Bearer <token>`.

Query Parameters

Name	Type	Default	Description
`tradePairId`	string
`tokenSlug`	string
`mptIssuanceId`	string
`interval`	enum<string>	`"1h"`	Available `1m3m5m15m30m1h2h4h`
`startTime`	integer
`endTime`	integer
`limit`	integer	`500`

Responses

200

application/json

Successful response

Field	Type	Description
`items`	object[]
`items[].tradePairId`	string	Trade pair identifier (UUID v4).
`items[].bucket`	integer	Start of the candle interval, Unix-seconds.
`items[].open`	string	Opening price (decimal string).
`items[].high`	string	Highest price in the interval (decimal string).
`items[].low`	string	Lowest price in the interval (decimal string).
`items[].close`	string	Closing price (decimal string).
`items[].volume`	string	Total volume traded in the interval (decimal string).
`items[].tradeCount`	number	Number of trades that make up the candle.

Example

Json

{
  "items": [
    {
      "tradePairId": "3c4a3de8-4218-400c-8c55-87dc27206753",
      "bucket": 1745712000,
      "open": "0.512",
      "high": "0.518",
      "low": "0.509",
      "close": "0.514",
      "volume": "128450.32",
      "tradeCount": 312
    }
  ]
}

400

application/json

Invalid input data

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

401

application/json

Authorization not provided

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

403

application/json

Insufficient access

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

404

application/json

Not found

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

500

application/json

Internal server error

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}