Indexer HTTP API
Base URL: https://indexer.testnet.firstaccess.exchange/v4. Every route is a GET returning
JSON. Numbers that can exceed a JavaScript number (sizes, prices, money) are strings, in
human units: prices in dollars a contract, sizes in contracts, USDC in dollars.
The routes are dYdX's indexer's at the chain's upstream commit, unchanged; the fork adds
chainMarket to every chain market (overview).
Some routes are empty on this chain (affiliates, trading rewards, leaderboards), and some answer
404 (screening, bridging, Turnkey, trader search, vaults; see the
overview).
Common parameters
| Parameter | Meaning |
|---|---|
address | A dydx1... address |
subaccountNumber | 0 to 128,000 |
parentSubaccountNumber | 0 to 127: a parent and its child subaccounts (dYdX's isolated-position layout) |
limit | At most 1,000 (the default) |
page | 1 or more, with (page − 1) × limit at most 25,000 |
createdBeforeOrAtHeight, createdBeforeOrAt | A height, or an ISO 8601 time |
ticker / market | A perpetual market's ticker, such as TESTCOPERP-USD |
Validation errors answer 400 with {"errors": [...]}; an unknown ticker or address 404.
Markets
| Route | Parameters | Returns |
|---|---|---|
/perpetualMarkets | limit, ticker (or market) | {markets: {[ticker]: PerpetualMarket}}, each with chainMarket on chain markets (overview) |
/orderbooks/perpetualMarket/{ticker} | {bids: [{price, size}], asks: [...]}, uncrossed, at most 100 levels a side, short-term orders included | |
/trades/perpetualMarket/{ticker} | limit, createdBeforeOrAtHeight, createdBeforeOrAt, page | {trades: [{id, side, size, price, type, createdAt, createdAtHeight}]} |
/candles/perpetualMarkets/{ticker} | resolution (required: 1MIN, 5MINS, 15MINS, 30MINS, 1HOUR, 4HOURS, 1DAY), limit, fromISO, toISO | {candles: [{startedAt, ticker, resolution, low, high, open, close, baseTokenVolume, usdVolume, trades, startingOpenInterest, orderbookMidPriceOpen, orderbookMidPriceClose}]} |
/historicalFunding/{ticker} | limit, effectiveBeforeOrAtHeight, effectiveBeforeOrAt | {historicalFunding: [{ticker, rate, price, effectiveAt, effectiveAtHeight}]} |
/sparklines | timePeriod (required: ONE_DAY, SEVEN_DAYS) | {[ticker]: [close, ...]} |
/height | {height, time} | |
/time | {iso, epoch} |
PerpetualMarket: clobPairId, ticker, status, oraclePrice, priceChange24H,
volume24H, trades24H, nextFundingRate, initialMarginFraction,
maintenanceMarginFraction, openInterest, atomicResolution, quantumConversionExponent,
tickSize, stepSize, stepBaseQuantums, subticksPerTick, marketType,
openInterestLowerCap, openInterestUpperCap, baseOpenInterest, defaultFundingRate1H,
and chainMarket. A binary's tickSize is "0.001" (subticksPerTick 1,000); every other
chain market's "0.01" (10,000).
Accounts
| Route | Parameters | Returns |
|---|---|---|
/addresses/{address} | {subaccounts: [Subaccount], totalTradingRewards} | |
/addresses/{address}/subaccountNumber/{n} | {subaccount: Subaccount} | |
/addresses/{address}/parentSubaccountNumber/{n} | {subaccount: {address, parentSubaccountNumber, equity, freeCollateral, childSubaccounts}} | |
/orders | address, subaccountNumber (both required), limit, ticker, side, type, includeTypes, excludeTypes, status, goodTilBlockBeforeOrAt, goodTilBlockAfter, goodTilBlockTimeBeforeOrAt, goodTilBlockTimeAfter, returnLatestOrders | [Order] |
/orders/parentSubaccountNumber | as /orders, with parentSubaccountNumber | [Order] |
/orders/{orderId} | Order (orderId is the indexer's UUID) | |
/fills | address, subaccountNumber, market + marketType (PERPETUAL), includeTypes, excludeTypes, limit, createdBeforeOrAtHeight, createdBeforeOrAt, page | {fills: [Fill]} |
/fills/parentSubaccountNumber | address, parentSubaccountNumber, limit, page | {fills: [Fill]} |
/tradeHistory | address, subaccountNumber, market + marketType, limit, page | {tradeHistory: [...]}: opens, extends, closes and liquidations with entry price, realized PnL and fees |
/perpetualPositions | address, subaccountNumber, status (OPEN, CLOSED, LIQUIDATED), limit, createdBeforeOrAtHeight, createdBeforeOrAt | {positions: [{market, status, side, size, maxSize, entryPrice, realizedPnl, unrealizedPnl, netFunding, sumOpen, sumClose, createdAt, createdAtHeight, closedAt, exitPrice, subaccountNumber}]} |
/assetPositions | address, subaccountNumber | {positions: [{symbol, side, size, assetId, subaccountNumber}]} |
/transfers | address, subaccountNumber, limit, createdBeforeOrAtHeight, createdBeforeOrAt, page | {transfers: [{id, sender, recipient, size, symbol, type, createdAt, createdAtHeight, transactionHash}]} |
/transfers/between | sourceAddress, sourceSubaccountNumber, recipientAddress, recipientSubaccountNumber | {transfersSubset, totalNetTransfers} |
/historical-pnl | address, subaccountNumber, limit, createdBeforeOrAt[Height], createdOnOrAfter[Height], page | {historicalPnl: [{equity, totalPnl, netTransfers, createdAt, blockHeight, blockTime}]} |
/fundingPayments | address, subaccountNumber, limit, ticker, createdOnOrAfter, page, showZeroPayments | {fundingPayments: [{createdAt, createdAtHeight, perpetualId, ticker, oraclePrice, size, side, rate, payment, subaccountNumber, fundingIndex}]} |
Most account routes also have a /parentSubaccountNumber form (/fundingPayments/parentSubaccount
for funding payments).
Subaccount: address, subaccountNumber, equity, freeCollateral,
openPerpetualPositions (by market), assetPositions (by symbol), marginEnabled,
updatedAtHeight, latestProcessedBlockHeight.
Order: id, subaccountId, clientId, clobPairId, side, size, totalFilled,
price, type, status, timeInForce, postOnly, reduceOnly, orderFlags,
goodTilBlock, goodTilBlockTime, createdAtHeight, clientMetadata, triggerPrice (a stop's
trigger),
builderAddress, feePpm, orderRouterAddress, ticker, subaccountNumber, updatedAt,
updatedAtHeight.
Fill: id, side, liquidity (TAKER, MAKER), type, market, marketType,
price, size, fee, affiliateRevShare, createdAt, createdAtHeight, orderId,
clientMetadata, subaccountNumber, builderFee, builderAddress, orderRouterAddress,
orderRouterFee, positionSizeBefore, entryPriceBefore, positionSideBefore.
Enums
| Enum | Values |
|---|---|
Order type | LIMIT, MARKET, STOP_LIMIT, STOP_MARKET, TRAILING_STOP, TAKE_PROFIT, TAKE_PROFIT_MARKET, TWAP, TWAP_SUBORDER |
Order status | OPEN, FILLED, CANCELED, BEST_EFFORT_CANCELED, UNTRIGGERED, BEST_EFFORT_OPENED |
timeInForce | GTT, IOC, FOK (post-only is postOnly: true) |
Fill type | LIMIT, LIQUIDATED, LIQUIDATION, DELEVERAGED, OFFSETTING, TWAP_SUBORDER |
Trade type | LIMIT, LIQUIDATED, DELEVERAGED, TWAP_SUBORDER |
Market status | ACTIVE, PAUSED, CANCEL_ONLY, POST_ONLY, INITIALIZING, FINAL_SETTLEMENT |
marketType | CROSS, ISOLATED |
Transfer type | TRANSFER_IN, TRANSFER_OUT, DEPOSIT, WITHDRAWAL |
BEST_EFFORT_OPENED and BEST_EFFORT_CANCELED are short-term orders the indexer has seen
placed or cancelled but not yet confirmed by a block.
Examples
const INDEXER = 'https://indexer.testnet.firstaccess.exchange/v4';
const get = async (path: string) => (await fetch(INDEXER + path)).json();
const book = await get('/orderbooks/perpetualMarket/TESTCOPERP-USD');
const { candles } = await get('/candles/perpetualMarkets/TESTCOPERP-USD?resolution=1HOUR&limit=24');
const { fills } = await get('/fills?address=dydx1...&subaccountNumber=1&limit=50');import httpx
INDEXER = "https://indexer.testnet.firstaccess.exchange/v4"
book = httpx.get(f"{INDEXER}/orderbooks/perpetualMarket/TESTCOPERP-USD").json()
candles = httpx.get(f"{INDEXER}/candles/perpetualMarkets/TESTCOPERP-USD", params={"resolution": "1HOUR", "limit": 24}).json()["candles"]
fills = httpx.get(f"{INDEXER}/fills", params={"address": "dydx1...", "subaccountNumber": 1, "limit": 50}).json()["fills"]curl -s https://indexer.testnet.firstaccess.exchange/v4/orderbooks/perpetualMarket/TESTCOPERP-USD
curl -s 'https://indexer.testnet.firstaccess.exchange/v4/candles/perpetualMarkets/TESTCOPERP-USD?resolution=1HOUR&limit=24'
curl -s 'https://indexer.testnet.firstaccess.exchange/v4/fills?address=dydx1...&subaccountNumber=1&limit=50'