Skip to main content
The REST API represents amounts, prices, and time the same way across every endpoint. Read this page once before parsing any response.
Every REST API request requires an API key in the x-api-key header. Request a key by emailing [email protected], then see REST API authentication for setup and quota details.

​
Identifiers

V1 and V2 pool ids are separate sequences: /pools/{poolId} and /v2/pools/{poolId} are different pools even when the id matches.

​
Units and amounts

HBAR-denominated values are expressed in tinybar, the smallest unit of HBAR: 1 HBAR = 100,000,000 tinybar. TVL, volume, and token price fields are all tinybar values. Token amounts are expressed in each token’s smallest unit, determined by its decimals field. SAUCE has 6 decimals, so a reserve of "242601707456381" is 242,601,707.456381 SAUCE. Large integers are returned as JSON strings. Fields such as price, tvl, volume, liquidity, and reserves exceed JavaScript’s safe-integer range, so keep them as strings or parse them with BigInt — casting to Number silently loses precision.

​
Timestamps

Candlestick objects carry both startTimestampSeconds (interval start) and timestampSeconds (interval end); point-in-time fields such as liquidity are measured at the interval end.

​
Interval endpoints

Historical endpoints take a required from and to in unix seconds plus an interval: Each candlestick family also has a latest variant that returns the most recent candle without a time range: latest token candlestick, latest candlesticks for all tokens, and latest V1 pool candlestick. Pool conversion-rate endpoints accept an optional inverted flag to flip the quote direction of the pair.

​
Pagination

REST API endpoints do not paginate: list endpoints return the full result set in one response. Bound the size of historical queries with from and to instead of requesting long ranges you do not need. The Orderbook API trade tape is the exception in the SaucerSwap API family — it takes page and limit parameters. See Orderbook market data.

​
Next steps

Errors and rate limits

Handle 401, 403, and 429 responses and monitor your monthly quota.

Token price history

Put the interval conventions to work on OHLCV candlestick data.

REST API authentication

Request an API key and read the quota headers on every response.

Developer quickstart

A curl ladder from token list to pool data to your first quote.