Skip to main content
Error

Authorizations

X-API-KEY
string
header
required

HMAC-SHA256 authentication. Sign every request and send X-API-KEY, X-API-SIGNATURE, X-API-TIMESTAMP and X-API-NONCE (see the Authentication guide). Each route also requires a specific claim on your API key (e.g. read:orders, write:orders, read:account, read:market-data).

Query Parameters

productId
string
required

Trading pair id (e.g. BTC-USDC).

Example:

"BTC-USDC"

timeframe
enum<string>
required

Candle bucket size. The server picks the Coinbase granularity and a sensible lookback for each value — see the operation description for the table.

Available options:
1m,
5m,
15m,
1h,
4h,
1d,
1w,
1M,
1Y
Example:

"1h"

granularity
enum<string>

Ignored — kept for backward compatibility. The server derives the effective granularity from timeframe. Older clients can still send a CandlesGranularity value; new code should just omit this.

Available options:
ONE_MINUTE,
FIVE_MINUTES,
FIFTEEN_MINUTES,
ONE_HOUR,
SIX_HOURS,
ONE_DAY,
THIRTY_MINUTES,
TWO_HOURS,
FOUR_HOURS

Response

200 - application/json
statusCode
number
required

HTTP status code echoed in the body.

Example:

200

success
boolean
required

True for success responses.

Example:

true

message
string

Human-readable status message.

Example:

"Request processed successfully"

data
object[]