Portal Community

list (PRD01)

Lists every tradable product. No operation-specific config keys.

Example response:

{
  "items": [{
    "productID": "BTC-USD",
    "baseCurrency": "BTC",
    "quoteCurrency": "USD",
    "price": "60123.45",
    "pricePercentageChange24H": "1.85",
    "volume24H": "12345.6789",
    "tradingDisabled": false,
    "productType": "SPOT"
  }]
}

get (PRD02)

Returns a single product record, same shape as list.

FieldRequiredDescription
productId✓ YesThe trading pair, e.g. BTC-USD.

getCandles (PRD03)

Returns OHLC candlestick data.

FieldRequiredDescription
productId✓ YesThe trading pair.
startNoDefaults to "now" when omitted. A present-but-malformed value is a validation error, not a silent fallback.
endNoSame rule as start.
granularityNoCandle bucket size. Defaults to ONE_HOUR.

Output items[], one OHLC candle per bucket: start, low, high, open, close, volume.

getMarketTrades (PRD04)

Returns recent public trades on a product.

FieldRequiredDescription
productId✓ YesThe trading pair.
limitNoMaximum number of trades to return.

Output items[]: tradeID, productID, price, size, side, time.

getBestBidAsk (PRD05)

Returns a top-of-book snapshot.

FieldRequiredDescription
productIdsNoComma-separated list of trading pairs. Omit for all products.

Output items[], one best-bid/ask snapshot per product.

getProductBook (PRD06)

Returns a full order-book snapshot.

FieldRequiredDescription
productId✓ YesThe trading pair.
limitNoMaximum depth per side.

Output is a single record: productID, bids[] and asks[] (each {price, size}), time.