Skip to main content
GET
List user asset rates

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

Path Parameters

asset_type
enum<string>
required

Classification of the asset (fiat, crypto, stablecoin, or xstock).

Available options:
fiat,
crypto,
xstock,
stablecoin
asset_symbol
string
required

Ticker symbol of an asset (e.g., BTC, USDC, EUR).

Required string length: 1 - 16
user_id
string
required

Globally unique public identifier for a user.

Required string length: 14 - 42

Query Parameters

quote_symbol
string
default:USD

Ticker symbol of the quote asset.

Required string length: 1 - 16
quote_type
enum<string>
default:fiat

Classification of the quote asset.

Available options:
fiat
start_timestamp
string<date-time>

Inclusive lower bound of the rate window. Defaults to end_timestamp - 7 days.

end_timestamp
string<date-time>

Exclusive upper bound of the rate window. Defaults to "now".

interval
enum<string>
default:PT15M

Sampling interval.

Available options:
PT1M,
PT5M,
PT15M,
PT30M,
PT60M,
PT4H,
P1D,
P7D,
P15D
page_size
integer<int32>
default:20

Maximum number of results to return. Ignored when page_token is present.

Required range: 1 <= x <= 100
page_token
string

Opaque token returned as next_page_token in the previous response. Omit to request the first page.

Required string length: 1 - 256

Response

Successful response

data
object[]
required

Available candles for this page's portion of the requested time window, in chronological order.

quote_symbol
string
required

Quote asset symbol the prices are denominated in.

quote_type
enum<string>
required

Classification of the quote asset.

Available options:
fiat
start_timestamp
string<date-time>
required

Resolved start of the window after defaults were applied.

end_timestamp
string<date-time>
required

Resolved end of the window after defaults were applied.

interval
enum<string>
default:PT15M
required

Resolved interval after defaults were applied.

Available options:
PT1M,
PT5M,
PT15M,
PT30M,
PT60M,
PT4H,
P1D,
P7D,
P15D
page_size
integer<int32>
required

Maximum number of results returned on this page. Echoes the page_size query parameter.

Required range: 1 <= x <= 100
next_page_token
string

Opaque token for retrieving the next page. Absent when there are no more results.

Required string length: 1 - 256