/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export interface paths { "/v1/svm/transfers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Token Transfers * @description Returns SPL token transfers with program, authority, and account information. */ get: operations["getV1SvmTransfers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/svm/balances": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Token Balances * @description Returns SPL token balances for Solana token owners with mint and program data. */ get: operations["getV1SvmBalances"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/svm/holders": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Token Holders * @description Returns top token holders ranked by balance. */ get: operations["getV1SvmHolders"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/svm/owner": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Account Owner Lookup * @description Returns owner address of an associated token account (ATA) with closure status. */ get: operations["getV1SvmOwner"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/svm/tokens": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Token Metadata * @description Provides SVM token contract metadata. */ get: operations["getV1SvmTokens"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/svm/transfers/native": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Native Transfers * @description Returns Native transfers with transaction and block data. */ get: operations["getV1SvmTransfersNative"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/svm/balances/native": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Native Balances * @description Returns SOL native balances for wallet addresses. */ get: operations["getV1SvmBalancesNative"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/svm/holders/native": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Native Holders * @description Returns top token holders ranked by Native balance. */ get: operations["getV1SvmHoldersNative"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/svm/tokens/native": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Native Metadata * @description Returns Native metadata including supply and holder count. */ get: operations["getV1SvmTokensNative"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/svm/swaps": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Swap Events * @description Returns AMM swap events from Solana DEXs with input/output tokens and amounts. */ get: operations["getV1SvmSwaps"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/svm/pools": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Liquidity Pools * @description Returns AMM pool information from Solana DEX protocols with transaction counts. */ get: operations["getV1SvmPools"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/svm/pools/ohlc": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Pool OHLCV * @description Provides pricing data in the Open/High/Low/Close/Volume (OHCLV) format for DEX pools. */ get: operations["getV1SvmPoolsOhlc"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/svm/dexes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Supported DEXs * @description Returns all supported Solana DEXs. */ get: operations["getV1SvmDexes"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/evm/transfers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Token Transfers * @description Returns ERC-20 transfers with transaction and block data. */ get: operations["getV1EvmTransfers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/evm/balances": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Token Balances * @description Returns ERC-20 token balances for a wallet address. */ get: operations["getV1EvmBalances"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/evm/holders": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Token Holders * @description Returns top token holders ranked by ERC-20 balance. */ get: operations["getV1EvmHolders"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/evm/tokens": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Token Metadata * @description Returns ERC-20 token metadata including supply and holder count. */ get: operations["getV1EvmTokens"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/evm/balances/historical": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Historical Token Balances * @description Returns wallet ERC-20 token balance changes over time in OHLCV format. * * OHLCV historical depth is subject to plan restrictions. */ get: operations["getV1EvmBalancesHistorical"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/evm/transfers/native": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Native Transfers * @description Returns Native transfers with transaction and block data. */ get: operations["getV1EvmTransfersNative"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/evm/balances/native": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Native Balances * @description Returns EVM native balances for wallet addresses. */ get: operations["getV1EvmBalancesNative"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/evm/holders/native": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Native Holders * @description Returns top token holders ranked by Native balance. */ get: operations["getV1EvmHoldersNative"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/evm/tokens/native": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Native Metadata * @description Returns Native metadata including supply and holder count. */ get: operations["getV1EvmTokensNative"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/evm/balances/historical/native": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Historical Native Balances * @description Returns wallet Native balance changes over time in OHLCV format. * * OHLCV historical depth is subject to plan restrictions. */ get: operations["getV1EvmBalancesHistoricalNative"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/evm/swaps": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Swap Events * @description Returns DEX swaps events with input & output token amounts. */ get: operations["getV1EvmSwaps"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/evm/pools": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Liquidity Pools * @description Returns DEX pool metadata including tokens, fees and protocol. */ get: operations["getV1EvmPools"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/evm/pools/ohlc": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Pool OHLCV * @description Returns OHLCV price data for liquidity pools. * * OHLCV historical depth is subject to plan restrictions. */ get: operations["getV1EvmPoolsOhlc"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/evm/dexes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Supported DEXs * @description Returns all supported EVM DEXs. */ get: operations["getV1EvmDexes"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/evm/nft/collections": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * NFT Collection * @description Returns NFT collection metadata, supply stats, owner count, and transfer history. */ get: operations["getV1EvmNftCollections"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/evm/nft/holders": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * NFT Holders * @description Returns wallet addresses holding NFT collection tokens with quantity and percentage distribution. */ get: operations["getV1EvmNftHolders"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/evm/nft/items": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * NFT Items * @description Returns NFT token metadata, attributes, current owner, and media URIs. */ get: operations["getV1EvmNftItems"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/evm/nft/ownerships": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * NFT Ownerships by Address * @description Returns NFT tokens owned by a wallet address with metadata and ownership information. */ get: operations["getV1EvmNftOwnerships"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/evm/nft/sales": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * NFT Sales * @description Returns NFT marketplace sales with price, buyer, seller, and transaction data. */ get: operations["getV1EvmNftSales"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/evm/nft/transfers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * NFT Transfers * @description Returns NFT transfer events including mints, burns, and ownership changes. */ get: operations["getV1EvmNftTransfers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/tvm/transfers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Token Transfers * @description Returns ERC-20 transfers with transaction and block data. */ get: operations["getV1TvmTransfers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/tvm/tokens": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Token Metadata * @description Provides ERC-20 token contract metadata. */ get: operations["getV1TvmTokens"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/tvm/transfers/native": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Native Transfers * @description Returns Native transfers with transaction and block data. */ get: operations["getV1TvmTransfersNative"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/tvm/tokens/native": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Native Metadata * @description Provides Native metadata. */ get: operations["getV1TvmTokensNative"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/tvm/swaps": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Swap Events * @description Returns DEX swaps events with input & output token amounts. * * Address semantics: `transaction_from` is the onchain transaction initiator and `user` is the normalized user-oriented swap address. `sender` and `recipient` remain available for legacy compatibility, but new integrations should prefer `user` and plan for `sender`/`recipient` deprecation in a future major release. */ get: operations["getV1TvmSwaps"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/tvm/pools": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Liquidity Pools * @description Returns DEX pool metadata including tokens, fees and protocol. */ get: operations["getV1TvmPools"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/tvm/pools/ohlc": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Pool OHLCV * @description Returns OHLCV price data for liquidity pools. * * OHLCV historical depth is subject to plan restrictions. */ get: operations["getV1TvmPoolsOhlc"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/tvm/dexes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Supported DEXs * @description Returns all supported TVM DEXs. */ get: operations["getV1TvmDexes"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/hyperliquid/dexes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Supported DEXs * @description Returns the list of perpetuals DEXs and spot, each with 24h activity stats (volume, trade count, unique users, asset count). Hyperliquid hosts a core perpetuals venue (`dex=perps`) alongside builder-deployed perpetuals DEXs that each list their own asset universe — `xyz` (commodities and macro indices), `cash` (tokenized equities), `km`, and others. * * Use this endpoint to discover valid `dex` filter values for venue-scoped queries on `/markets`, `/markets/activity`, `/markets/liquidations`, `/users`, and `/users/positions`. * * For platform-wide totals across all DEXs over arbitrary intervals, use `/v1/hyperliquid/platform`. * * **Public — no auth required.** */ get: operations["getV1HyperliquidDexes"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/hyperliquid/markets": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Market Lookup * @description Returns the latest snapshot per market: last trade price, 24h change versus the prior-day close, 24h volume (split by side), trade and unique-user counts, and the most recent open interest and funding rate observed at the last funding snapshot. * * Filters compose additively — pass `coin`, `dex`, `base_token`, and/or `quote_token` to narrow the scope. A mismatched combination (e.g. `coin=cash:TSLA&dex=xyz`) returns empty. Omit all for a full listing sorted by 24h volume. * * `base_token` and `quote_token` are spot-discovery filters: `?base_token=HYPE` returns every spot pair where HYPE sits on the base side (HYPE/USDC, HYPE/USDT0, …). Use the `coin` from the result as the identifier on the rest of the `/v1/hyperliquid/*` endpoints. */ get: operations["getV1HyperliquidMarkets"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/hyperliquid/markets/ohlc": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Market OHLCV * @description Returns OHLCV candles for a single coin and interval, derived from regular trade fills. Volume is broken down both by side (`buy_volume`, `ask_volume`) and — on perpetuals — by directional intent (`open_long_volume`, `close_long_volume`, `open_short_volume`, `close_short_volume`) so consumers can distinguish whether price moves are driven by fresh exposure or position unwinds. On spot markets the directional-intent fields are zero; the side-volume fields carry the buy/sell breakdown directly. * * For liquidation-only candles (with mark-price OHLC), use `/v1/hyperliquid/markets/liquidations/ohlc`. */ get: operations["getV1HyperliquidMarketsOhlc"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/hyperliquid/markets/oi": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Market Open Interest * @description Returns the historical open-interest and funding-rate time series for a coin at the requested interval. `open_interest` is the sum of absolute signed position sizes across all users at each funding snapshot. * * Each row also exposes the directional positioning split (`long_size`, `short_size`, `net_position`, plus `long_positions` and `short_positions` as user counts) and funding aggregates (`funding_rate`, `total_funding`, `positive_funding`, `negative_funding`) — useful for detecting crowded sides, funding pressure, and position flushes. */ get: operations["getV1HyperliquidMarketsOi"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/hyperliquid/markets/activity": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Market Activity * @description Returns a chronological fill feed, filterable by `coin`, `dex`, and/or `user`. Each row is a single fill carrying price, size, side (`BID` or `ASK`), directional intent (`OPEN_LONG`, `CLOSE_SHORT`, `LIQUIDATED_CROSS_LONG`, `AUTO_DELEVERAGING`, and others), closed PnL, fees (negative values represent maker rebates), and order-level metadata (`order_id`, `client_order_id`, `twap_id`, `crossed`). * * For balance-changing events on a user (deposits, withdrawals, funding payments, vault flows), use `/v1/hyperliquid/users/activity`. * * At least one of `coin`, `dex`, or `user` is required. Filters compose additively — pass any combination to narrow further; a mismatched pair (e.g. `coin=cash:TSLA&dex=xyz`) returns empty. * * Defaults to the last 24 hours when no time range is specified — provide `start_time` and `end_time` to query older data. */ get: operations["getV1HyperliquidMarketsActivity"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/hyperliquid/markets/liquidations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Market Liquidations * @description Returns one row per liquidation event, aggregated across the multiple fills that walk the book during a liquidation. Only the liquidated user's side is returned — counterparty fills are excluded. * * Each row surfaces the coin, liquidated user, transaction hash, liquidation kind (`CROSS_LONG`, `ISOLATED_SHORT`, and others), total size and notional, size-weighted average fill price, the mark price at liquidation, and the liquidation method reported by the venue (`backstop` and others). * * Filter by `coin`, `dex`, and/or `liquidated_user` — filters compose additively. Sort by `notional` (default — largest events first) or `time` (most recent first). */ get: operations["getV1HyperliquidMarketsLiquidations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/hyperliquid/markets/liquidations/ohlc": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Market Liquidations OHLCV * @description Returns liquidation-only OHLCV candles for a single coin and interval. Adds mark-price OHLC (`mark_price_open`, `mark_price_high`, `mark_price_low`, `mark_price_close`) — the price feed used for margining at liquidation time — alongside the standard trade-price OHLC. Volume and counts cover the liquidation fills only. * * For all-fill candles, use `/v1/hyperliquid/markets/ohlc`. */ get: operations["getV1HyperliquidMarketsLiquidationsOhlc"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/hyperliquid/users": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * User Lookup * @description Returns trading aggregates per user: fill count, volume broken down by side, total fees (negative values represent net maker rebates), realized PnL, net funding paid or received, liquidation-fill count, distinct coins traded, and first/last trade timestamps. * * Omit `user` for leaderboard mode — returns a paginated list sorted by `sort_by`. Provide `user` for profile mode — returns a single row. Filters `coin` and `dex` compose additively — pass either or both to narrow the scope (`coin=BTC` for one market, `dex=xyz` for one venue, both together for redundancy). A mismatched combination (e.g. `coin=cash:TSLA&dex=xyz`) returns an empty result. * * Aggregation windows are fixed via the `interval` parameter — `1h`, `1d`, `1w`, `30d`, or omit for all-time. Data is refreshed hourly, so `1h` lags up to 1h. * * Vaults trade as normal accounts, so passing a vault address as `user` returns its trading performance — pair with `/v1/hyperliquid/vaults` for depositor-side stats. */ get: operations["getV1HyperliquidUsers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/hyperliquid/users/positions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * User Positions * @description Returns the current signed position (`position_size`) per coin for a user, reconstructed from the latest funding snapshot per `(user, coin)` pair. Positive `position_size` indicates a long position, negative indicates a short. Each row also carries the funding rate applied at that snapshot and the snapshot timestamp. * * Filter by `coin` for a single coin, or `dex` to return only positions on one venue (`xyz`, `cash`, etc.). * * Caveat: positions opened and fully closed between two funding snapshots are never observed during settlement and will not appear here. */ get: operations["getV1HyperliquidUsersPositions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/hyperliquid/users/activity": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * User Activity * @description Returns a chronological feed of balance-changing events for a user — bridge deposits/withdrawals, on-chain account deposits/withdrawals, vault deposits/withdrawals, liquidations, and funding payments. Each row carries an `event_type` discriminator and a `notes` field with type-specific extras (e.g. funding rate and position size for funding events). * * For trade fills, use `/v1/hyperliquid/markets/activity` instead. * * Supply `event_types` (comma-separated) to filter to a subset. Defaults to the last 30 days when no time range is specified — provide `start_time` and `end_time` to query older data. */ get: operations["getV1HyperliquidUsersActivity"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/hyperliquid/vaults": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Vault Listings * @description Returns vault summaries — leader, lifetime flow totals (deposits, withdrawals, distributions, leader commissions), depositor and event counts, and last-activity timestamp. * * Vault trading PnL/volume is exposed via `/v1/hyperliquid/users` with the vault address as `user` (vaults trade as normal accounts on Hyperliquid). Per-depositor breakdowns live on `/v1/hyperliquid/vaults/depositors`. * * Vaults predating our indexer cutover (2026-02-02) have no `ledger_vault_creates` row and come back with `leader`/`created_at` as null and `initial_deposit`/`create_fee` as 0. */ get: operations["getV1HyperliquidVaults"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/hyperliquid/vaults/depositors": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Vault Depositors * @description Returns the per-depositor breakdown for a single vault — one row per `(user, vault)` pair with lifetime deposits, lifetime net withdrawals (after vault commission and closing cost), distributions received, deposit and withdrawal counts, and last-activity timestamp. * * For the vault-level summary, see `/v1/hyperliquid/vaults`. */ get: operations["getV1HyperliquidVaultsDepositors"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/hyperliquid/platform": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Platform Activity * @description Returns a platform-wide time series aggregating all coins and DEXs into one row per `timestamp`. Each row carries trade volume (split by side), trade and counterparty counts, distinct active coins, total fees, and a liquidation slice (`liquidations_volume`, `liquidations_count`, `unique_liquidated_users`). * * Use this endpoint instead of summing per-coin or per-DEX data client-side when you need cross-market totals. Per-coin OHLCV lives on `/v1/hyperliquid/markets/ohlc`; per-DEX on `/v1/hyperliquid/dexes`. */ get: operations["getV1HyperliquidPlatform"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/polymarket/markets": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Market Lookup * @description Returns market metadata including question, outcomes with token IDs, volume, and status. Each market has exactly two outcomes (binary); multi-outcome scenarios are modeled as multiple markets grouped under one event. * * Use this to discover `token_id` values needed for OHLCV and position queries, or to resolve a slug to identifiers. When no identifier is provided, returns a paginated list for discovery. */ get: operations["getV1PolymarketMarkets"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/polymarket/markets/ohlc": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Market OHLCV * @description Returns OHLCV price data for a single outcome token. Each market has two outcome tokens (e.g. Yes and No) — use `/v1/polymarket/markets` to discover them. * * Prices are in USD per share (0 to 1). Volume and fees are in USDC. */ get: operations["getV1PolymarketMarketsOhlc"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/polymarket/markets/oi": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Market Open Interest * @description Returns open interest time-series for a market. Open interest is the USDC collateral locked into conditional token positions — it increases on splits (deposit USDC to mint Yes+No pairs) and decreases on merges (return pairs to withdraw USDC) or redemptions. * * Provide **one** of `condition_id` or `market_slug`. */ get: operations["getV1PolymarketMarketsOi"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/polymarket/markets/activity": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Market Activity * @description Returns a chronological feed of on-chain trades, position splits, merges, and redemptions. Each row includes the transaction hash, block number, and scaled amounts. * * For trades, `market.token_id` and `market.outcome_label` identify the specific outcome token. For splits, merges, and redemptions, these are null because the operation applies to the market as a whole. * * At least one of `user`, `token_id`, or `condition_id` is required. Defaults to the last 24 hours when no time range is specified — provide `start_time` and `end_time` to query older data. */ get: operations["getV1PolymarketMarketsActivity"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/polymarket/markets/positions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Market Positions * @description Returns all user positions for a specific outcome token — a leaderboard view. Each row is one user's cumulative position: cost basis, PNL, shares held, and current value. * * For a user's portfolio across all markets, use `/v1/polymarket/positions` instead. */ get: operations["getV1PolymarketMarketsPositions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/polymarket/platform": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Platform Aggregates * @description Returns platform-wide time-series combining trading volume, open interest, and fee aggregates across all Polymarket markets. */ get: operations["getV1PolymarketPlatform"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/polymarket/users": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * User Lookup * @description Returns trading statistics per user: volume, PNL (realized, unrealized, total), trade counts, and activity window. When no user address is provided, returns a paginated leaderboard for discovery. * * Supports lookback windows via `interval`: `1h`, `1d`, `1w`, `30d`. Omit for all-time. Data refreshes hourly. */ get: operations["getV1PolymarketUsers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/polymarket/users/positions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * User Positions * @description Returns a user's positions with PNL breakdown per outcome token. Each row is one token's cumulative position: cost basis, realized PNL, net shares held, average entry price, and current market price. * * Use `closed=false` for positions on live markets, or `closed=true` for resolved markets. */ get: operations["getV1PolymarketUsersPositions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/health": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Health Check * @description Verifies that all database connections are established. */ get: operations["getV1Health"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/version": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * API Version Info * @description Returns API version, build date, and commit information. */ get: operations["getV1Version"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/networks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Supported Networks * @description Returns supported blockchain networks with identifiers, metadata, and indexed block information per database category. */ get: operations["getV1Networks"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/SKILLS.md": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Agent Skills Reference * @description Returns the public Markdown reference for AI agents integrating with Token API. */ get: operations["getSkillsMarkdown"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/llms.txt": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * LLM Documentation Index * @description Returns the public llms.txt documentation index for AI tools discovering Token API. */ get: operations["getLlmsText"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/openapi": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * OpenAPI Specification * @description Returns the public OpenAPI specification for Token API. */ get: operations["getOpenapiSpec"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; } export type webhooks = Record; export interface components { schemas: never; responses: never; parameters: never; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export interface operations { getV1SvmTransfers: { parameters: { query: { /** @description The Graph Network ID for SVM networks https://thegraph.com/networks */ network: "solana"; /** @description Filter by transaction signature
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ signature?: string | string[]; /** @description Filter by mint address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ mint?: string | string[]; /** @description Filter by token account address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ source?: string | string[]; /** @description Filter by token account address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ destination?: string | string[]; /** @description Filter by SPL token program ID
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ program_id?: ("11111111111111111111111111111111" | "TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb" | "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA") | string | ("11111111111111111111111111111111" | "TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb" | "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA")[]; /** @description Filter by authority address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ authority?: string | string[]; /** @description Filter by token account address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ fee_payer?: string | string[]; /** @description Filter by token account address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ signer?: string | string[]; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Filter by block number */ start_block?: number; /** @description Filter by block number */ end_block?: number; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { block_num: number; datetime: string; timestamp: number; signature: string; transaction_index: number; instruction_index: number; stack_height: number; /** * Format: svm-address * @description Filter by address * @example So11111111111111111111111111111111111111112 */ signer: string; signers: string[]; fee: number; compute_units_consumed: number; /** * @description Filter by SPL token program ID * @example TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb * @enum {string} */ program_id: "11111111111111111111111111111111" | "TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb" | "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"; /** * Format: svm-address * @description Filter by mint address * @example pumpCmXqMfrsAkQ5r49WcJnRayYRqmXz6ae8H7H9Dfn */ mint: string; /** * Format: svm-address * @description Filter by address * @example So11111111111111111111111111111111111111112 */ source: string; /** * Format: svm-address * @description Filter by address * @example So11111111111111111111111111111111111111112 */ destination: string; /** * Format: svm-address * @description Filter by authority address * @example GXYBNgyYKbSLr938VJCpmGLCUaAHWsncTi7jDoQSdFR9 */ authority: string; multisig_authority: string[]; amount: string; /** @description Decimal-scaled token amount (= amount / 10^decimals). Not a USD value. */ value: number; decimals: number | null; name: string | null; symbol: string | null; uri: string | null; metadata: string | null; /** * @description The Graph Network ID for SVM networks https://thegraph.com/networks * @example solana * @enum {string} */ network: "solana"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1SvmBalances: { parameters: { query: { /** @description The Graph Network ID for SVM networks https://thegraph.com/networks */ network: "solana"; /** @description Filter by owner address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ owner: string | string[]; /** @description Filter by token account address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ token_account?: string | string[]; /** @description Filter by mint address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ mint?: string | string[]; /** @description Filter by SPL token program ID */ program_id?: "11111111111111111111111111111111" | "TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb" | "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"; /** @description Include zero/null balances in results */ include_null_balances?: boolean; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { last_update: string; last_update_block_num: number; last_update_timestamp: number; /** * @description Filter by SPL token program ID * @example TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb * @enum {string} */ program_id: "11111111111111111111111111111111" | "TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb" | "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"; /** * Format: svm-address * @description Filter by owner address * @example GXYBNgyYKbSLr938VJCpmGLCUaAHWsncTi7jDoQSdFR9 */ owner: string; /** * Format: svm-address * @description Filter by token account address */ token_account: string; /** * Format: svm-address * @description Filter by mint address * @example pumpCmXqMfrsAkQ5r49WcJnRayYRqmXz6ae8H7H9Dfn */ mint: string; amount: string; /** @description Decimal-scaled token amount (= amount / 10^decimals). Not a USD value. */ value: number; decimals: number | null; name: string | null; symbol: string | null; uri: string | null; /** * @description The Graph Network ID for SVM networks https://thegraph.com/networks * @example solana * @enum {string} */ network: "solana"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1SvmHolders: { parameters: { query: { /** @description The Graph Network ID for SVM networks https://thegraph.com/networks */ network: "solana"; /** @description Filter by mint address */ mint: string; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { last_update: string; last_update_block_num: number; last_update_timestamp: number; /** * Format: svm-address * @description Filter by program ID * @example JUP6LkbZbjS1jKKwapdHNy74zcZ3tLUZoi5QNyVTaV4 */ program_id: string; /** * Format: svm-address * @description Filter by mint address * @example pumpCmXqMfrsAkQ5r49WcJnRayYRqmXz6ae8H7H9Dfn */ mint: string; /** * Format: svm-address * @description Filter by owner address * @example GXYBNgyYKbSLr938VJCpmGLCUaAHWsncTi7jDoQSdFR9 */ owner: string; /** * Format: svm-address * @description Filter by token account address */ token_account: string; amount: string; /** @description Decimal-scaled token amount (= amount / 10^decimals). Not a USD value. */ value: number; decimals: number; name: string | null; symbol: string | null; uri: string | null; /** * @description The Graph Network ID for SVM networks https://thegraph.com/networks * @example solana * @enum {string} */ network: "solana"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1SvmOwner: { parameters: { query: { /** @description The Graph Network ID for SVM networks https://thegraph.com/networks */ network: "solana"; /** @description Filter by token account address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ account: string | string[]; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { last_update: string; last_update_block_num: number; last_update_timestamp: number; /** * Format: svm-address * @description Filter by token account address */ account: string; /** * Format: svm-address * @description Filter by owner address * @example GXYBNgyYKbSLr938VJCpmGLCUaAHWsncTi7jDoQSdFR9 */ owner: string; is_closed: boolean; /** * @description The Graph Network ID for SVM networks https://thegraph.com/networks * @example solana * @enum {string} */ network: "solana"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1SvmTokens: { parameters: { query: { /** @description The Graph Network ID for SVM networks https://thegraph.com/networks */ network: "solana"; /** @description Filter by mint address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ mint?: string | string[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { last_update: string; last_update_block_num: number; last_update_timestamp: number; /** * @description Filter by SPL token program ID * @example TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb * @enum {string} */ program_id: "11111111111111111111111111111111" | "TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb" | "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"; /** * Format: svm-address * @description Filter by mint address * @example pumpCmXqMfrsAkQ5r49WcJnRayYRqmXz6ae8H7H9Dfn */ mint: string; decimals: number | null; circulating_supply: number; holders: number; name: string | null; symbol: string | null; uri: string | null; network: string; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1SvmTransfersNative: { parameters: { query: { /** @description The Graph Network ID for SVM networks https://thegraph.com/networks */ network: "solana"; /** @description Filter by transaction signature
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ signature?: string | string[]; /** @description Filter by token account address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ source?: string | string[]; /** @description Filter by token account address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ destination?: string | string[]; /** @description Filter by token account address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ fee_payer?: string | string[]; /** @description Filter by token account address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ signer?: string | string[]; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Filter by block number */ start_block?: number; /** @description Filter by block number */ end_block?: number; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { block_num: number; datetime: string; timestamp: number; signature: string; transaction_index: number; instruction_index: number; stack_height: number; /** * Format: svm-address * @description Filter by address * @example So11111111111111111111111111111111111111112 */ fee_payer: string; /** * Format: svm-address * @description Filter by address * @example So11111111111111111111111111111111111111112 */ signer: string; signers: string[]; fee: number; compute_units_consumed: number; /** * Format: svm-address * @description Filter by address * @example 11111111111111111111111111111111 */ program_id: string; /** * Format: svm-address * @description Filter by address * @example So11111111111111111111111111111111111111111 */ mint: string; /** * Format: svm-address * @description Filter by address * @example So11111111111111111111111111111111111111112 */ source: string; /** * Format: svm-address * @description Filter by address * @example So11111111111111111111111111111111111111112 */ destination: string; amount: string; /** @description Decimal-scaled token amount (= amount / 10^decimals). Not a USD value. */ value: number; decimals: number | null; name: string | null; symbol: string | null; /** * @description The Graph Network ID for SVM networks https://thegraph.com/networks * @example solana * @enum {string} */ network: "solana"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1SvmBalancesNative: { parameters: { query: { /** @description The Graph Network ID for SVM networks https://thegraph.com/networks */ network: "solana"; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ address: string | string[]; /** @description Include zero/null balances in results */ include_null_balances?: boolean; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { last_update: string; last_update_block_num: number; last_update_timestamp: number; /** * @description Filter by SPL token program ID * @example TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb * @enum {string} */ program_id: "11111111111111111111111111111111" | "TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb" | "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"; /** * Format: svm-address * @description Filter by address * @example So11111111111111111111111111111111111111112 */ address: string; /** * Format: svm-address * @description Filter by mint address * @example pumpCmXqMfrsAkQ5r49WcJnRayYRqmXz6ae8H7H9Dfn */ mint: string; amount: string; /** @description Decimal-scaled token amount (= amount / 10^decimals). Not a USD value. */ value: number; decimals: number | null; name: string | null; symbol: string | null; /** * @description The Graph Network ID for SVM networks https://thegraph.com/networks * @example solana * @enum {string} */ network: "solana"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1SvmHoldersNative: { parameters: { query: { /** @description The Graph Network ID for SVM networks https://thegraph.com/networks */ network: "solana"; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { last_update: string; last_update_block_num: number; last_update_timestamp: number; /** * Format: svm-address * @description Filter by program ID * @example JUP6LkbZbjS1jKKwapdHNy74zcZ3tLUZoi5QNyVTaV4 */ program_id: string; /** * Format: svm-address * @description Filter by mint address * @example pumpCmXqMfrsAkQ5r49WcJnRayYRqmXz6ae8H7H9Dfn */ mint: string; /** * Format: svm-address * @description Filter by token account address */ token_account: string; amount: string; /** @description Decimal-scaled token amount (= amount / 10^decimals). Not a USD value. */ value: number; decimals: number; name: string | null; symbol: string | null; /** * @description The Graph Network ID for SVM networks https://thegraph.com/networks * @example solana * @enum {string} */ network: "solana"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1SvmTokensNative: { parameters: { query: { /** @description The Graph Network ID for SVM networks https://thegraph.com/networks */ network: "solana"; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { last_update: string; last_update_block_num: number; last_update_timestamp: number; /** * @description Filter by SPL token program ID * @example TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb * @enum {string} */ program_id: "11111111111111111111111111111111" | "TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb" | "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"; /** * Format: svm-address * @description Filter by mint address * @example pumpCmXqMfrsAkQ5r49WcJnRayYRqmXz6ae8H7H9Dfn */ mint: string; decimals: number | null; circulating_supply: number; holders: number; name: string; symbol: string; network: string; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1SvmSwaps: { parameters: { query: { /** @description The Graph Network ID for SVM networks https://thegraph.com/networks */ network: "solana"; /** @description Filter by transaction signature
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ signature?: string | string[]; /** @description Filter by AMM address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ amm?: string | string[]; /** @description Filter by AMM pool address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ amm_pool?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ user?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ fee_payer?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ signer?: string | string[]; /** @description Filter by mint address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ input_mint?: string | string[]; /** @description Protocol name */ protocol?: "jupiter_v4" | "jupiter_v6" | "pumpfun" | "pumpfun_amm" | "raydium_amm_v4" | "raydium_clmm" | "raydium_cpmm" | "raydium_launchpad" | "meteora_daam" | "meteora_dlmm" | "meteora_amm" | "orca_whirlpool" | "boop" | "byreal" | "darklake" | "dumpfun" | "moonshot" | "pancakeswap" | "spl_token_swap" | "okx_dex"; /** @description Filter by mint address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ output_mint?: string | string[]; /** @description Filter by program ID
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ program_id?: string | string[]; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Filter by block number */ start_block?: number; /** @description Filter by block number */ end_block?: number; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { block_num: number; datetime: string; timestamp: number; /** * Format: svm-signature * @description Filter by transaction signature * @example 5pdoVcSiSBr3LMAijdRYKrL5RoLFjLgHxHbZ34dUBVubnsQt3q1v48LuPazebsSiBVuSbSTyJdzf3G9jqqn8o6jA */ signature: string; transaction_index: number; instruction_index: number; stack_height: number; /** * Format: svm-address * @description Filter by address * @example So11111111111111111111111111111111111111112 */ fee_payer: string; /** * Format: svm-address * @description Filter by address * @example So11111111111111111111111111111111111111112 */ signer: string; signers: string[]; fee: number; compute_units_consumed: number; /** * Format: svm-address * @description Filter by program ID * @example JUP6LkbZbjS1jKKwapdHNy74zcZ3tLUZoi5QNyVTaV4 */ program_id: string; program_name: string; /** * Format: svm-address * @description Filter by AMM address * @example 675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8 */ amm: string; /** * Format: svm-address * @description Filter by AMM pool address * @example AmmpSnW5xVeKHTAU9fMjyKEMPgrzmUj3ah5vgvHhAB5J */ amm_pool: string; input_token: { address: string | null; symbol: string | null; decimals: number | null; }; output_token: { address: string | null; symbol: string | null; decimals: number | null; }; /** * Format: svm-address * @description Filter by address * @example So11111111111111111111111111111111111111112 */ user: string; /** * Format: svm-address * @description Filter by mint address * @example pumpCmXqMfrsAkQ5r49WcJnRayYRqmXz6ae8H7H9Dfn */ input_mint: string; input_amount: string; input_value: number; /** * Format: svm-address * @description Filter by mint address * @example pumpCmXqMfrsAkQ5r49WcJnRayYRqmXz6ae8H7H9Dfn */ output_mint: string; output_amount: string; output_value: number; /** * @description Protocol name * @example raydium_amm_v4 * @enum {string} */ protocol: "jupiter_v4" | "jupiter_v6" | "pumpfun" | "pumpfun_amm" | "raydium_amm_v4" | "raydium_clmm" | "raydium_cpmm" | "raydium_launchpad" | "meteora_daam" | "meteora_dlmm" | "meteora_amm" | "orca_whirlpool" | "boop" | "byreal" | "darklake" | "dumpfun" | "moonshot" | "pancakeswap" | "spl_token_swap" | "okx_dex"; summary: string; /** * @description The Graph Network ID for SVM networks https://thegraph.com/networks * @example solana * @enum {string} */ network: "solana"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1SvmPools: { parameters: { query: { /** @description The Graph Network ID for SVM networks https://thegraph.com/networks */ network: "solana"; /** @description Filter by AMM address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ amm?: string | string[]; /** @description Filter by AMM pool address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ amm_pool?: string | string[]; /** @description Filter by mint address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ mint?: string | string[]; /** @description Filter by program ID
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ program_id?: string | string[]; /** @description Protocol name */ protocol?: "pumpfun" | "pumpfun_amm" | "raydium_amm_v4" | "raydium_clmm" | "raydium_cpmm" | "raydium_launchpad" | "meteora_daam" | "meteora_dlmm" | "meteora_amm" | "orca_whirlpool" | "boop" | "byreal" | "darklake" | "dumpfun" | "moonshot" | "pancakeswap" | "spl_token_swap" | "okx_dex"; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** * Format: svm-address * @description Filter by program ID * @example JUP6LkbZbjS1jKKwapdHNy74zcZ3tLUZoi5QNyVTaV4 */ program_id: string; program_name: string; /** * Format: svm-address * @description Filter by AMM address * @example 675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8 */ amm: string; amm_name: string; /** * Format: svm-address * @description Filter by AMM pool address * @example AmmpSnW5xVeKHTAU9fMjyKEMPgrzmUj3ah5vgvHhAB5J */ amm_pool: string; /** * Format: svm-address * @description Filter by mint address * @example pumpCmXqMfrsAkQ5r49WcJnRayYRqmXz6ae8H7H9Dfn */ input_mint: string; input_decimals: number | null; /** * Format: svm-address * @description Filter by mint address * @example pumpCmXqMfrsAkQ5r49WcJnRayYRqmXz6ae8H7H9Dfn */ output_mint: string; output_decimals: number | null; transactions: number; /** * @description The Graph Network ID for SVM networks https://thegraph.com/networks * @example solana * @enum {string} */ network: "solana"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1SvmPoolsOhlc: { parameters: { query: { /** @description The Graph Network ID for SVM networks https://thegraph.com/networks */ network: "solana"; /** @description Filter by AMM pool address */ amm_pool: string; /** @description The interval* for which to aggregate price data (1-minute, 5-minutes, 10-minutes, 30-minutes, hourly, 4-hours, daily or weekly).
*Plan restricted. */ interval?: "1m" | "5m" | "10m" | "30m" | "1h" | "4h" | "1d" | "1w"; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { datetime: string; /** * Format: svm-address * @description Filter by program ID * @example JUP6LkbZbjS1jKKwapdHNy74zcZ3tLUZoi5QNyVTaV4 */ program_id: string; /** * Format: svm-address * @description Filter by AMM address * @example 675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8 */ amm: string; /** * Format: svm-address * @description Filter by AMM pool address * @example AmmpSnW5xVeKHTAU9fMjyKEMPgrzmUj3ah5vgvHhAB5J */ amm_pool: string; token0: string; token0_decimals: number; token1: string; token1_decimals: number; open: number; high: number; low: number; close: number; volume: number; uaw: number; transactions: number; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1SvmDexes: { parameters: { query: { /** @description The Graph Network ID for SVM networks https://thegraph.com/networks */ network: "solana"; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** * Format: svm-address * @description Filter by program ID * @example JUP6LkbZbjS1jKKwapdHNy74zcZ3tLUZoi5QNyVTaV4 */ program_id: string; program_name: string; /** * Format: svm-address * @description Filter by AMM address * @example 675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8 */ amm: string; amm_name: string; is_aggregator: boolean; transactions: number; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1EvmTransfers: { parameters: { query: { /** @description The Graph Network ID for EVM networks https://thegraph.com/networks */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; /** @description Filter by transaction hash
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ transaction_id?: string | string[]; /** @description Filter by contract address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ contract?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ from_address?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ to_address?: string | string[]; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Filter by block number */ start_block?: number; /** @description Filter by block number */ end_block?: number; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { block_num: number; datetime: string; timestamp: number; /** * Format: evm-tx-hash * @description Filter by transaction hash * @example 0xf6374799c227c9db38ff5ac1d5bebe8b607a1de1238cd861ebd1053ec07305ca */ transaction_id: string; /** * Format: evm-address * @description Filter by contract address * @example 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2 */ contract: string; /** * Format: evm-address * @description Filter by address * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ from: string; /** * Format: evm-address * @description Filter by address * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ to: string; name: string | null; symbol: string | null; decimals: number | null; amount: string; /** @description Decimal-scaled token amount (= amount / 10^decimals). Not a USD value. */ value: number; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1EvmBalances: { parameters: { query: { /** @description The Graph Network ID for EVM networks https://thegraph.com/networks */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ address: string | string[]; /** @description Filter by contract address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ contract?: string | string[]; /** @description Include zero/null balances in results */ include_null_balances?: boolean; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { last_update: string; last_update_block_num: number; last_update_timestamp: number; /** * Format: evm-address * @description Filter by address * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ address: string; /** * Format: evm-address * @description Filter by contract address * @example 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2 */ contract: string; amount: string; /** @description Decimal-scaled token amount (= amount / 10^decimals). Not a USD value. */ value: number; name: string | null; symbol: string | null; decimals: number | null; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1EvmHolders: { parameters: { query: { /** @description The Graph Network ID for EVM networks https://thegraph.com/networks */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; /** @description Filter by contract address */ contract: string; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { last_update: string; last_update_block_num: number; last_update_timestamp: number; /** * Format: evm-address * @description Filter by address * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ address: string; /** * Format: evm-address * @description Filter by contract address * @example 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2 */ contract: string; amount: string; /** @description Decimal-scaled token amount (= amount / 10^decimals). Not a USD value. */ value: number; is_contract: boolean; name: string | null; symbol: string | null; decimals: number | null; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1EvmTokens: { parameters: { query: { /** @description The Graph Network ID for EVM networks https://thegraph.com/networks */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; /** @description Filter by contract address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ contract: string | string[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { last_update: string; last_update_block_num: number; last_update_timestamp: number; /** * Format: evm-address * @description Filter by contract address * @example 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2 */ contract: string; name: string | null; symbol: string | null; decimals: number | null; circulating_supply: number; total_supply: number; holders: number; total_transfers: number; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; icon?: { web3icon: string; }; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1EvmBalancesHistorical: { parameters: { query: { /** @description The Graph Network ID for EVM networks https://thegraph.com/networks */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; /** @description Filter by address */ address: string; /** @description Filter by contract address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ contract?: string | string[]; /** @description The interval* for which to aggregate price data (hourly, 4-hours, daily or weekly).
*Plan restricted. */ interval?: "1h" | "4h" | "1d" | "1w"; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { datetime: string; /** * Format: evm-address * @description Filter by address * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ address: string; /** * Format: evm-address * @description Filter by contract address * @example 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2 */ contract: string; decimals: number; open: number; high: number; low: number; close: number; name: string | null; symbol: string | null; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1EvmTransfersNative: { parameters: { query: { /** @description The Graph Network ID for EVM networks https://thegraph.com/networks */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; /** @description Filter by transaction hash
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ transaction_id?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ from_address?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ to_address?: string | string[]; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Filter by block number */ start_block?: number; /** @description Filter by block number */ end_block?: number; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { block_num: number; datetime: string; timestamp: number; /** * Format: evm-tx-hash * @description Filter by transaction hash * @example 0xf6374799c227c9db38ff5ac1d5bebe8b607a1de1238cd861ebd1053ec07305ca */ transaction_id: string; /** * Format: evm-address * @description Filter by address * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ from: string; /** * Format: evm-address * @description Filter by address * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ to: string; name: string | null; symbol: string | null; decimals: number | null; amount: string; /** @description Decimal-scaled token amount (= amount / 10^decimals). Not a USD value. */ value: number; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1EvmBalancesNative: { parameters: { query: { /** @description The Graph Network ID for EVM networks https://thegraph.com/networks */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ address: string | string[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { last_update: string; last_update_block_num: number; last_update_timestamp: number; /** * Format: evm-address * @description Filter by address * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ address: string; amount: string; /** @description Decimal-scaled token amount (= amount / 10^decimals). Not a USD value. */ value: number; name: string | null; symbol: string | null; decimals: number | null; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1EvmHoldersNative: { parameters: { query: { /** @description The Graph Network ID for EVM networks https://thegraph.com/networks */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { last_update: string; last_update_block_num: number; last_update_timestamp: number; /** * Format: evm-address * @description Filter by address * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ address: string; amount: string; /** @description Decimal-scaled token amount (= amount / 10^decimals). Not a USD value. */ value: number; is_contract: boolean; name: string | null; symbol: string | null; decimals: number | null; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1EvmTokensNative: { parameters: { query: { /** @description The Graph Network ID for EVM networks https://thegraph.com/networks */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { last_update: string; last_update_block_num: number; last_update_timestamp: number; name: string | null; symbol: string | null; decimals: number | null; circulating_supply: number; total_supply: number; holders: number; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; icon?: { web3icon: string; }; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1EvmBalancesHistoricalNative: { parameters: { query: { /** @description The Graph Network ID for EVM networks https://thegraph.com/networks */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; /** @description Filter by address */ address: string; /** @description The interval* for which to aggregate price data (hourly, 4-hours, daily or weekly).
*Plan restricted. */ interval?: "1h" | "4h" | "1d" | "1w"; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { datetime: string; /** * Format: evm-address * @description Filter by address * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ address: string; /** * Format: evm-address * @description Filter by contract address * @example 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2 */ contract: string; decimals: number; open: number; high: number; low: number; close: number; name: string | null; symbol: string | null; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1EvmSwaps: { parameters: { query: { /** @description The Graph Network ID for EVM networks https://thegraph.com/networks */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; /** @description Filter by transaction hash
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ transaction_id?: string | string[]; /** @description Filter by factory address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ factory?: string | string[]; /** @description Filter by pool address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ pool?: string | (string) | (string)[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ caller?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ transaction_from?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ user?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ sender?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ recipient?: string | string[]; /** @description Filter by contract address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ input_contract?: string | string[]; /** @description Filter by contract address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ output_contract?: string | string[]; /** @description Protocol name */ protocol?: "uniswap_v1" | "uniswap_v2" | "uniswap_v3" | "uniswap_v4" | "curvefi" | "balancer" | "bancor" | "cow" | "aerodrome" | "dodo" | "woofi" | "traderjoe" | "kyber_elastic"; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Filter by block number */ start_block?: number; /** @description Filter by block number */ end_block?: number; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { block_num: number; datetime: string; timestamp: number; transaction_id: string; transaction_index: number; /** * Format: evm-address * @description Onchain transaction initiator address. * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ transaction_from: string; call_index: number | null; log_index: number; log_ordinal: number; log_block_index: number; log_topic0: string; /** * Format: evm-address * @description Filter by factory address * @example 0x5c69bee701ef814a2b6a3edd4b1652cb9cc5aa6f */ factory: string; /** * @description Filter by pool address * @example 0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640 */ pool: string; input_token: { address: string | null; symbol: string | null; decimals: number | null; }; output_token: { address: string | null; symbol: string | null; decimals: number | null; }; /** * Format: evm-address * @description Account or contract that calls the swap-relevant contract. * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ caller: string; /** * Format: evm-address * @description Normalized user-oriented swap address. Prefer this field for integrations; sender and recipient remain legacy compatibility fields and are planned for deprecation in a future major release. * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ user: string; /** * Format: evm-address * @description Legacy compatibility field for swap sender semantics. Prefer user for a normalized user-oriented swap address. * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ sender: string; /** * Format: evm-address * @description Legacy compatibility field for swap recipient semantics. Prefer user for a normalized user-oriented swap address. * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ recipient: string; input_amount: string; input_value: number; output_amount: string; output_value: number; price: number; price_inv: number; /** * @description Protocol name * @example uniswap_v3 * @enum {string} */ protocol: "uniswap_v1" | "uniswap_v2" | "uniswap_v3" | "uniswap_v4" | "curvefi" | "balancer" | "bancor" | "cow" | "aerodrome" | "dodo" | "woofi" | "traderjoe" | "kyber_elastic"; summary: string; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1EvmPools: { parameters: { query: { /** @description The Graph Network ID for EVM networks https://thegraph.com/networks */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; /** @description Filter by factory address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ factory?: string | string[]; /** @description Filter by pool address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ pool?: string | (string) | (string)[]; /** @description Filter by contract address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ input_token?: string | string[]; /** @description Filter by contract address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ output_token?: string | string[]; /** @description Protocol name */ protocol?: "uniswap_v1" | "uniswap_v2" | "uniswap_v3" | "uniswap_v4" | "curvefi" | "balancer" | "bancor" | "cow" | "aerodrome" | "dodo" | "woofi" | "traderjoe" | "kyber_elastic"; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** * @description Filter by pool address * @example 0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640 */ pool: string; /** * Format: evm-address * @description Filter by factory address * @example 0x5c69bee701ef814a2b6a3edd4b1652cb9cc5aa6f */ factory: string; /** * @description Protocol name * @example uniswap_v3 * @enum {string} */ protocol: "uniswap_v1" | "uniswap_v2" | "uniswap_v3" | "uniswap_v4" | "curvefi" | "balancer" | "bancor" | "cow" | "aerodrome" | "dodo" | "woofi" | "traderjoe" | "kyber_elastic"; input_token: { address: string | null; symbol: string | null; decimals: number | null; }; output_token: { address: string | null; symbol: string | null; decimals: number | null; }; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1EvmPoolsOhlc: { parameters: { query: { /** @description The Graph Network ID for EVM networks https://thegraph.com/networks */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; /** @description Filter by pool address */ pool: string; /** @description The interval* for which to aggregate price data (1-minute, 5-minutes, 10-minutes, 30-minutes, hourly, 4-hours, daily or weekly).
*Plan restricted. */ interval?: "1m" | "5m" | "10m" | "30m" | "1h" | "4h" | "1d" | "1w"; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { datetime: string; ticker: string; /** * @description Filter by pool address * @example 0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640 */ pool: string; open: number; high: number; low: number; close: number; volume: number; transactions: number; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1EvmDexes: { parameters: { query: { /** @description The Graph Network ID for EVM networks https://thegraph.com/networks */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** * Format: evm-address * @description Filter by address * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ factory: string; /** * @description Protocol name * @example uniswap_v3 * @enum {string} */ protocol: "uniswap_v1" | "uniswap_v2" | "uniswap_v3" | "uniswap_v4" | "curvefi" | "balancer" | "bancor" | "cow" | "aerodrome" | "dodo" | "woofi" | "traderjoe" | "kyber_elastic"; uaw: number; transactions: number; /** @description ISO 8601 datetime string */ last_activity: string; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1EvmNftCollections: { parameters: { query: { /** @description The Graph Network ID for EVM networks https://thegraph.com/networks */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; /** @description Filter by contract address */ contract: string; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { contract_creation: string; /** * Format: evm-address * @description Filter by address * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ contract_creator: string; /** * Format: evm-address * @description Filter by contract address * @example 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2 */ contract: string; name: string | null; symbol: string | null; owners: number; total_supply: number; total_unique_supply: number; total_transfers: number; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1EvmNftHolders: { parameters: { query: { /** @description The Graph Network ID for EVM networks https://thegraph.com/networks */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; /** @description Filter by contract address */ contract: string; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** * Format: evm-address * @description Filter by contract address * @example 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2 */ contract: string; /** * @description Token standard * @example ERC721 * @enum {string} */ token_standard: "ERC721" | "ERC1155"; /** * Format: evm-address * @description Filter by address * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ address: string; /** @description Number of tokens held by this address */ quantity: number; /** @description Number of unique token IDs held by this address */ unique_tokens: number; /** @description Percentage of total supply held by this address */ percentage: number; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1EvmNftItems: { parameters: { query: { /** @description The Graph Network ID for EVM networks https://thegraph.com/networks */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; /** @description Filter by contract address */ contract: string; /** @description Token ID
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ token_id?: string | string[]; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** * Format: evm-address * @description Filter by address * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ address: string; /** * Format: evm-address * @description Filter by contract address * @example 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2 */ contract: string; /** * @description Token ID * @example 5712 */ token_id: string; /** * @description Token standard * @example ERC721 * @enum {string} */ token_standard: "ERC721" | "ERC1155"; name: string | null; description: string | null; image: string | null; uri: string | null; attributes: { trait_type: string; value: string; display_type?: string; }[]; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1EvmNftOwnerships: { parameters: { query: { /** @description The Graph Network ID for EVM networks https://thegraph.com/networks */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ address: string | string[]; /** @description Filter by contract address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ contract?: string | string[]; /** @description Token ID
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ token_id?: string | string[]; /** @description Token standard */ token_standard?: "ERC721" | "ERC1155"; /** @description Include zero/null balances in results */ include_null_balances?: boolean; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** * Format: evm-address * @description Filter by address * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ address: string; /** * Format: evm-address * @description Filter by contract address * @example 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2 */ contract: string; /** * @description Token ID * @example 5712 */ token_id: string; /** * @description Token standard * @example ERC721 * @enum {string} */ token_standard: "ERC721" | "ERC1155"; name: string | null; symbol: string | null; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1EvmNftSales: { parameters: { query: { /** @description The Graph Network ID for EVM networks https://thegraph.com/networks */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; /** @description Filter by transaction hash
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ transaction_id?: string | string[]; /** @description Filter by contract address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ contract?: string | string[]; /** @description Token ID
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ token_id?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ address?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ from_address?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ to_address?: string | string[]; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Filter by block number */ start_block?: number; /** @description Filter by block number */ end_block?: number; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { block_num: number; datetime: string; timestamp: number; /** * Format: evm-tx-hash * @description Filter by transaction hash * @example 0xf6374799c227c9db38ff5ac1d5bebe8b607a1de1238cd861ebd1053ec07305ca */ transaction_id: string; /** * Format: evm-address * @description Filter by contract address * @example 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2 */ contract: string; /** * @description Token ID * @example 5712 */ token_id: string; name: string | null; symbol: string | null; /** * Format: evm-address * @description Filter by address * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ offerer: string; /** * Format: evm-address * @description Filter by address * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ recipient: string; sale_amount: number; sale_currency: string; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1EvmNftTransfers: { parameters: { query: { /** @description The Graph Network ID for EVM networks https://thegraph.com/networks */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; /** @description Transfer category */ type?: "BURN" | "MINT" | "TRANSFER"; /** @description Filter by transaction hash
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ transaction_id?: string | string[]; /** @description Filter by contract address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ contract?: string | string[]; /** @description Token ID
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ token_id?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ address?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ from_address?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ to_address?: string | string[]; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Filter by block number */ start_block?: number; /** @description Filter by block number */ end_block?: number; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { block_num: number; datetime: string; timestamp: number; /** * @description Transfer category * @example TRANSFER * @enum {string} */ "@type": "BURN" | "MINT" | "TRANSFER"; transfer_type: string; /** * Format: evm-tx-hash * @description Filter by transaction hash * @example 0xf6374799c227c9db38ff5ac1d5bebe8b607a1de1238cd861ebd1053ec07305ca */ transaction_id: string; /** * Format: evm-address * @description Filter by contract address * @example 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2 */ contract: string; /** * @description Token ID * @example 5712 */ token_id: string; name: string | null; symbol: string | null; /** * @description Token standard * @example ERC721 * @enum {string} */ token_standard: "ERC721" | "ERC1155"; /** * Format: evm-address * @description Filter by address * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ from: string; /** * Format: evm-address * @description Filter by address * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ to: string; amount: string; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1TvmTransfers: { parameters: { query: { /** @description The Graph Network ID for TVM networks https://thegraph.com/networks */ network: "tron"; /** @description Filter by transaction hash
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ transaction_id?: string | string[]; /** @description Filter by contract address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ contract?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ from_address?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ to_address?: string | string[]; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Filter by block number */ start_block?: number; /** @description Filter by block number */ end_block?: number; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { block_num: number; datetime: string; timestamp: number; /** * Format: tvm-tx-hash * @description Filter by transaction hash * @example daddbf0810fb73620ebb1ad3c915afd32f3cf13a267d740f27284583df97a01a */ transaction_id: string; transaction_index: number; log_index: number; log_ordinal: number; /** * Format: tvm-address * @description Filter by contract address * @example TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t */ contract: string; /** * Format: tvm-address * @description Filter by address * @example TRX9Uehj3GuFVh5jjVjNqb6q9cgVHJ4jGX */ from: string; /** * Format: tvm-address * @description Filter by address * @example TRX9Uehj3GuFVh5jjVjNqb6q9cgVHJ4jGX */ to: string; amount: string; /** @description Decimal-scaled token amount (= amount / 10^decimals). Not a USD value. */ value: number; name: string | null; symbol: string | null; decimals: number | null; /** * @description The Graph Network ID for TVM networks https://thegraph.com/networks * @example tron * @enum {string} */ network: "tron"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1TvmTokens: { parameters: { query: { /** @description The Graph Network ID for TVM networks https://thegraph.com/networks */ network: "tron"; /** @description Filter by contract address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ contract: string | string[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { last_update: string; last_update_block_num: number; last_update_timestamp: number; /** * Format: tvm-address * @description Filter by contract address * @example TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t */ contract: string; total_transfers: number; decimals: number | null; name: string | null; symbol: string | null; /** * @description The Graph Network ID for TVM networks https://thegraph.com/networks * @example tron * @enum {string} */ network: "tron"; icon?: { web3icon: string; }; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1TvmTransfersNative: { parameters: { query: { /** @description The Graph Network ID for TVM networks https://thegraph.com/networks */ network: "tron"; /** @description Filter by transaction hash
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ transaction_id?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ from_address?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ to_address?: string | string[]; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Filter by block number */ start_block?: number; /** @description Filter by block number */ end_block?: number; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { block_num: number; datetime: string; timestamp: number; /** * Format: tvm-tx-hash * @description Filter by transaction hash * @example daddbf0810fb73620ebb1ad3c915afd32f3cf13a267d740f27284583df97a01a */ transaction_id: string; transaction_index: number; /** * Format: tvm-address * @description Filter by address * @example TRX9Uehj3GuFVh5jjVjNqb6q9cgVHJ4jGX */ from: string; /** * Format: tvm-address * @description Filter by address * @example TRX9Uehj3GuFVh5jjVjNqb6q9cgVHJ4jGX */ to: string; amount: string; /** @description Decimal-scaled token amount (= amount / 10^decimals). Not a USD value. */ value: number; name: string | null; symbol: string | null; decimals: number | null; /** * @description The Graph Network ID for TVM networks https://thegraph.com/networks * @example tron * @enum {string} */ network: "tron"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1TvmTokensNative: { parameters: { query: { /** @description The Graph Network ID for TVM networks https://thegraph.com/networks */ network: "tron"; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { last_update: string; last_update_block_num: number; last_update_timestamp: number; decimals: number | null; name: string | null; symbol: string | null; network: string; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1TvmSwaps: { parameters: { query: { /** @description The Graph Network ID for TVM networks https://thegraph.com/networks */ network: "tron"; /** @description Filter by transaction hash
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ transaction_id?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ factory?: string | string[]; /** @description Filter by pool address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ pool?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ transaction_from?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ user?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ sender?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ recipient?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ input_contract?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ output_contract?: string | string[]; /** @description Protocol name */ protocol?: "uniswap_v1" | "uniswap_v2" | "uniswap_v3" | "uniswap_v4" | "sunpump"; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Filter by block number */ start_block?: number; /** @description Filter by block number */ end_block?: number; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { block_num: number; datetime: string; timestamp: number; transaction_id: string; transaction_index: number; /** * Format: tvm-address * @description Onchain transaction initiator address. * @example TRX9Uehj3GuFVh5jjVjNqb6q9cgVHJ4jGX */ transaction_from: string; log_index: number; log_ordinal: number; log_block_index: number; log_topic0: string; /** * Format: tvm-address * @description Filter by factory address * @example TKWJdrQkqHisa1X8HUdHEfREvTzw4pMAaY */ factory: string; /** * Format: tvm-address * @description Filter by pool address * @example TFGDbUyP8xez44C76fin3bn3Ss6jugoUwJ */ pool: string; input_token: { /** * Format: tvm-address * @description Filter by address * @example TRX9Uehj3GuFVh5jjVjNqb6q9cgVHJ4jGX */ address: string; symbol: string; name: string; decimals: number; }; output_token: { /** * Format: tvm-address * @description Filter by address * @example TRX9Uehj3GuFVh5jjVjNqb6q9cgVHJ4jGX */ address: string; symbol: string; name: string; decimals: number; }; /** * Format: tvm-address * @description Normalized user-oriented swap address. Prefer this field for integrations; sender and recipient remain legacy compatibility fields and are planned for deprecation in a future major release. * @example TRX9Uehj3GuFVh5jjVjNqb6q9cgVHJ4jGX */ user: string; /** * Format: tvm-address * @description Legacy compatibility field for swap sender semantics. Prefer user for a normalized user-oriented swap address. * @example TRX9Uehj3GuFVh5jjVjNqb6q9cgVHJ4jGX */ sender: string; /** * Format: tvm-address * @description Legacy compatibility field for swap recipient semantics. Prefer user for a normalized user-oriented swap address. * @example TRX9Uehj3GuFVh5jjVjNqb6q9cgVHJ4jGX */ recipient: string; input_amount: string; input_value: number; output_amount: string; output_value: number; price: number; price_inv: number; /** * @description Protocol name * @example uniswap_v2 * @enum {string} */ protocol: "uniswap_v1" | "uniswap_v2" | "uniswap_v3" | "uniswap_v4" | "sunpump"; summary: string; /** * @description The Graph Network ID for TVM networks https://thegraph.com/networks * @example tron * @enum {string} */ network: "tron"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1TvmPools: { parameters: { query: { /** @description The Graph Network ID for TVM networks https://thegraph.com/networks */ network: "tron"; /** @description Filter by factory address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ factory?: string | string[]; /** @description Filter by pool address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ pool?: string | string[]; /** @description Filter by contract address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ input_token?: string | string[]; /** @description Filter by contract address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ output_token?: string | string[]; /** @description Protocol name */ protocol?: "uniswap_v1" | "uniswap_v2" | "uniswap_v3" | "uniswap_v4" | "sunpump"; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** * Format: evm-address * @description Filter by factory address * @example 0x5c69bee701ef814a2b6a3edd4b1652cb9cc5aa6f */ factory: string; /** * @description Filter by pool address * @example 0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640 */ pool: string; input_token: { address: string | null; symbol: string | null; decimals: number | null; }; output_token: { address: string | null; symbol: string | null; decimals: number | null; }; fee: number; /** * @description Protocol name * @example uniswap_v3 * @enum {string} */ protocol: "uniswap_v1" | "uniswap_v2" | "uniswap_v3" | "uniswap_v4" | "curvefi" | "balancer" | "bancor" | "cow" | "aerodrome" | "dodo" | "woofi" | "traderjoe" | "kyber_elastic"; /** * @description The Graph Network ID for EVM networks https://thegraph.com/networks * @example mainnet * @enum {string} */ network: "arbitrum-one" | "avalanche" | "base" | "bsc" | "mainnet" | "optimism" | "polygon" | "unichain"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1TvmPoolsOhlc: { parameters: { query: { /** @description The Graph Network ID for TVM networks https://thegraph.com/networks */ network: "tron"; /** @description Filter by pool address */ pool: string; /** @description The interval* for which to aggregate price data (1-minute, 5-minutes, 10-minutes, 30-minutes, hourly, 4-hours, daily or weekly).
*Plan restricted. */ interval?: "1m" | "5m" | "10m" | "30m" | "1h" | "4h" | "1d" | "1w"; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { datetime: string; ticker: string; /** * Format: tvm-address * @description Filter by pool address * @example TFGDbUyP8xez44C76fin3bn3Ss6jugoUwJ */ pool: string; open: number; high: number; low: number; close: number; volume: number; transactions: number; /** * @description The Graph Network ID for TVM networks https://thegraph.com/networks * @example tron * @enum {string} */ network: "tron"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1TvmDexes: { parameters: { query: { /** @description The Graph Network ID for TVM networks https://thegraph.com/networks */ network: "tron"; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** * Format: tvm-address * @description Filter by address * @example TRX9Uehj3GuFVh5jjVjNqb6q9cgVHJ4jGX */ factory: string; /** * @description Protocol name * @example uniswap_v2 * @enum {string} */ protocol: "uniswap_v1" | "uniswap_v2" | "uniswap_v3" | "uniswap_v4" | "sunpump"; transactions: number; uaw: number; last_activity: string; /** * @description The Graph Network ID for TVM networks https://thegraph.com/networks * @example tron * @enum {string} */ network: "tron"; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1HyperliquidDexes: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** * @description DEX identifier. `perps` for core perps, `spot` for `@N` spot pairs, or a builder DEX name (`xyz`, `cash`, …). Call `/v1/hyperliquid/dexes` for the live set. * @example perps * @example spot * @example xyz * @example cash * @example km * @example hyna * @example flx * @example vntl * @example para */ dex: string; assets: number; volume_24h: number; trades_24h: number; unique_users_24h: number; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1HyperliquidMarkets: { parameters: { query?: { /** @description Hyperliquid coin identifier. Core perps have no prefix (`BTC`, `HYPE`); spot pairs use `@N` (`@107`); builder DEXs prefix the symbol with the DEX name (`xyz:SILVER`).
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ coin?: string | string[]; /** @description DEX identifier. `perps` for core perps, `spot` for `@N` spot pairs, or a builder DEX name (`xyz`, `cash`, …). Call `/v1/hyperliquid/dexes` for the live set.
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ dex?: string | string[]; /** @description Spot token symbol (e.g. `HYPE`, `USDC`). Use to discover all spot pairs with this token on a given side via `/v1/hyperliquid/markets?base_token=...` or `?quote_token=...`.
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ base_token?: string | string[]; /** @description Spot token symbol (e.g. `HYPE`, `USDC`). Use to discover all spot pairs with this token on a given side via `/v1/hyperliquid/markets?base_token=...` or `?quote_token=...`.
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ quote_token?: string | string[]; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { coin: string; market_name: string; dex: string; base_token: string | null; quote_token: string | null; price: number; price_24h: number | null; price_24h_change: number; volume_24h: number; buy_volume_24h: number; sell_volume_24h: number; trades_24h: number; unique_users_24h: number; open_interest: number | null; funding_rate: number | null; funding_snapshot_time: string | null; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1HyperliquidMarketsOhlc: { parameters: { query: { /** @description Hyperliquid coin identifier. Core perps have no prefix (`BTC`, `HYPE`); spot pairs use `@N` (`@107`); builder DEXs prefix the symbol with the DEX name (`xyz:SILVER`). */ coin: string; /** @description DEX identifier. `perps` for core perps, `spot` for `@N` spot pairs, or a builder DEX name (`xyz`, `cash`, …). Call `/v1/hyperliquid/dexes` for the live set. */ dex?: string; /** @description The interval* for which to aggregate price data (1-minute, 5-minutes, 10-minutes, 30-minutes, hourly, 4-hours, daily or weekly).
*Plan restricted. */ interval?: "1m" | "5m" | "10m" | "30m" | "1h" | "4h" | "1d" | "1w"; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { timestamp: string; coin: string; market_name: string; dex: string; interval_min: number; open: number; high: number; low: number; close: number; buy_volume: number; sell_volume: number; gross_volume: number; net_volume: number; open_long_volume: number; close_long_volume: number; open_short_volume: number; close_short_volume: number; transactions: number; buys: number; sells: number; unique_users: number; total_fees: number; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1HyperliquidMarketsOi: { parameters: { query: { /** @description Hyperliquid coin identifier. Core perps have no prefix (`BTC`, `HYPE`); spot pairs use `@N` (`@107`); builder DEXs prefix the symbol with the DEX name (`xyz:SILVER`).
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ coin: string | string[]; /** @description DEX identifier. `perps` for core perps, `spot` for `@N` spot pairs, or a builder DEX name (`xyz`, `cash`, …). Call `/v1/hyperliquid/dexes` for the live set.
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ dex?: string | string[]; /** @description The interval* for which to aggregate price data (1-minute, 5-minutes, 10-minutes, 30-minutes, hourly, 4-hours, daily or weekly).
*Plan restricted. */ interval?: "1m" | "5m" | "10m" | "30m" | "1h" | "4h" | "1d" | "1w"; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { timestamp: string; coin: string; market_name: string; dex: string; interval_min: number; open_interest: number; net_position: number; long_size: number; short_size: number; long_positions: number; short_positions: number; funding_rate: number; total_funding: number; positive_funding: number; negative_funding: number; funding_events: number; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1HyperliquidMarketsActivity: { parameters: { query?: { /** @description Hyperliquid coin identifier. Core perps have no prefix (`BTC`, `HYPE`); spot pairs use `@N` (`@107`); builder DEXs prefix the symbol with the DEX name (`xyz:SILVER`).
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ coin?: string | string[]; /** @description DEX identifier. `perps` for core perps, `spot` for `@N` spot pairs, or a builder DEX name (`xyz`, `cash`, …). Call `/v1/hyperliquid/dexes` for the live set.
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ dex?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ user?: string | string[]; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { block_num: number; timestamp: string; transaction_hash: string; transaction_id: number; coin: string; market_name: string; dex: string; user: string; side: string; direction: string; price: number; size: number; notional: number; start_position: string; closed_pnl: number; fee: number; fee_token: string; order_id: number; client_order_id: string; twap_id: number; crossed: boolean; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1HyperliquidMarketsLiquidations: { parameters: { query?: { /** @description Hyperliquid coin identifier. Core perps have no prefix (`BTC`, `HYPE`); spot pairs use `@N` (`@107`); builder DEXs prefix the symbol with the DEX name (`xyz:SILVER`).
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ coin?: string | string[]; /** @description DEX identifier. `perps` for core perps, `spot` for `@N` spot pairs, or a builder DEX name (`xyz`, `cash`, …). Call `/v1/hyperliquid/dexes` for the live set.
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ dex?: string | string[]; /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ liquidated_user?: string | string[]; sort_by?: "notional" | "time"; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { block_num: number; timestamp: string; event_hash: string; coin: string; market_name: string; dex: string; liquidated_user: string; direction: string; liquidation_kind: string; fills: number; total_size: number; notional: number; avg_fill_price: number; mark_price: number; liquidation_method: string; total_fees: number; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1HyperliquidMarketsLiquidationsOhlc: { parameters: { query: { /** @description Hyperliquid coin identifier. Core perps have no prefix (`BTC`, `HYPE`); spot pairs use `@N` (`@107`); builder DEXs prefix the symbol with the DEX name (`xyz:SILVER`). */ coin: string; /** @description DEX identifier. `perps` for core perps, `spot` for `@N` spot pairs, or a builder DEX name (`xyz`, `cash`, …). Call `/v1/hyperliquid/dexes` for the live set. */ dex?: string; /** @description The interval* for which to aggregate price data (1-minute, 5-minutes, 10-minutes, 30-minutes, hourly, 4-hours, daily or weekly).
*Plan restricted. */ interval?: "1m" | "5m" | "10m" | "30m" | "1h" | "4h" | "1d" | "1w"; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { timestamp: string; coin: string; market_name: string; dex: string; interval_min: number; open: number; high: number; low: number; close: number; mark_price_open: number; mark_price_high: number; mark_price_low: number; mark_price_close: number; buy_volume: number; sell_volume: number; gross_volume: number; net_volume: number; open_long_volume: number; close_long_volume: number; open_short_volume: number; close_short_volume: number; transactions: number; buys: number; sells: number; unique_liquidators: number; unique_liquidated: number; total_fees: number; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1HyperliquidUsers: { parameters: { query?: { /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ user?: string | string[]; /** @description Lookback window for user statistics (1 hour, 1 day, 1 week, 30 days). Omit for all-time. */ interval?: "1h" | "1d" | "1w" | "30d"; sort_by?: "total_volume" | "transactions" | "total_fees" | "realized_pnl" | "total_funding" | "liquidation_fills"; /** @description Hyperliquid coin identifier. Core perps have no prefix (`BTC`, `HYPE`); spot pairs use `@N` (`@107`); builder DEXs prefix the symbol with the DEX name (`xyz:SILVER`).
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ coin?: string | string[]; /** @description DEX identifier. `perps` for core perps, `spot` for `@N` spot pairs, or a builder DEX name (`xyz`, `cash`, …). Call `/v1/hyperliquid/dexes` for the live set.
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ dex?: string | string[]; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { user: string; coin: string | null; dex: string | null; interval: string | null; transactions: number; buys: number; sells: number; volume_bought: number; volume_sold: number; total_volume: number; total_fees: number; realized_pnl: number; total_funding: number; liquidation_fills: number; coins_traded: number; first_trade: string; last_trade: string; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1HyperliquidUsersPositions: { parameters: { query: { /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ user: string | string[]; /** @description Hyperliquid coin identifier. Core perps have no prefix (`BTC`, `HYPE`); spot pairs use `@N` (`@107`); builder DEXs prefix the symbol with the DEX name (`xyz:SILVER`).
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ coin?: string | string[]; /** @description DEX identifier. `perps` for core perps, `spot` for `@N` spot pairs, or a builder DEX name (`xyz`, `cash`, …). Call `/v1/hyperliquid/dexes` for the live set.
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ dex?: string | string[]; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { user: string; coin: string; market_name: string; dex: string; position_size: number; funding_rate: number; last_update: string; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1HyperliquidUsersActivity: { parameters: { query: { /** @description Filter by address */ user: string; /** @description Filter by balance-event type.
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ event_types?: "bridge_deposit" | "bridge_withdraw_pending" | "bridge_withdraw_finalized" | "deposit" | "withdraw" | "vault_deposit" | "vault_withdraw" | "liquidation" | "funding"; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { block_num: number; timestamp: string; transaction_hash: string; event_index: number; /** * @description Filter by balance-event type. * @enum {string} */ event_type: "bridge_deposit" | "bridge_withdraw_pending" | "bridge_withdraw_finalized" | "deposit" | "withdraw" | "vault_deposit" | "vault_withdraw" | "liquidation" | "funding"; user: string; counterparty: string; amount: number; token: string; notes: string; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1HyperliquidVaults: { parameters: { query?: { /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ vault?: string | string[]; sort_by?: "lifetime_deposits" | "lifetime_withdrawals" | "lifetime_distributions" | "depositor_count" | "last_activity_at"; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { vault: string; leader: string | null; created_at: string | null; initial_deposit: number; create_fee: number; lifetime_deposits: number; lifetime_withdrawals: number; lifetime_distributions: number; lifetime_leader_commissions: number; depositor_count: number; deposit_count: number; withdrawal_count: number; last_activity_at: string | null; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1HyperliquidVaultsDepositors: { parameters: { query: { /** @description Filter by address
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ vault: string | string[]; sort_by?: "deposits" | "withdrawals" | "distributions_received" | "last_activity_at"; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { user: string; /** * Format: evm-address * @description Filter by address * @example 0xd8da6bf26964af9d7eed9e03e53415d37aa96045 */ vault: string; deposits: number; deposit_count: number; withdrawals: number; withdrawal_count: number; distributions_received: number; last_activity_at: string; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1HyperliquidPlatform: { parameters: { query?: { /** @description The interval* for which to aggregate price data (1-minute, 5-minutes, 10-minutes, 30-minutes, hourly, 4-hours, daily or weekly).
*Plan restricted. */ interval?: "1m" | "5m" | "10m" | "30m" | "1h" | "4h" | "1d" | "1w"; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { timestamp: string; interval_min: number; volume: number; buy_volume: number; sell_volume: number; transactions: number; buys: number; sells: number; active_coins: number; total_fees: number; liquidations_volume: number; liquidations_count: number; unique_liquidated_users: number; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1PolymarketMarkets: { parameters: { query?: { /** @description undefined
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ condition_id?: string | string[]; /** @description undefined
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ market_slug?: string | string[]; /** @description undefined
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ token_id?: string | string[]; /** @description undefined
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ event_slug?: string | string[]; closed?: boolean; sort_by?: "volume" | "end_date" | "start_date"; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { condition_id: string; market_slug: string; event_slug: string | null; event_title: string | null; question: string; description: string; outcomes: { label: string; token_id: string; }[]; closed: boolean; neg_risk: boolean; accepting_orders: boolean; fees_enabled: boolean; volume: number; start_date: string; end_date: string; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1PolymarketMarketsOhlc: { parameters: { query: { token_id: string; /** @description The interval* for which to aggregate price data (1-minute, 5-minutes, 10-minutes, 30-minutes, hourly, 4-hours, daily or weekly).
*Plan restricted. */ interval?: "1m" | "5m" | "10m" | "30m" | "1h" | "4h" | "1d" | "1w"; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { timestamp: string; open: number; high: number; low: number; close: number; volume: number; trades: number; buys: number; sells: number; unique_makers: number; unique_takers: number; total_fees: number; total_refunds: number; net_fees: number; fee_count: number; effective_fee_rate_gross: number; effective_fee_rate: number; market: { condition_id: string | null; market_slug: string | null; token_id: string; outcome_label: string | null; closed: boolean; }; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1PolymarketMarketsOi: { parameters: { query?: { condition_id?: string; market_slug?: string; /** @description The interval* for which to aggregate price data (1-minute, 5-minutes, 10-minutes, 30-minutes, hourly, 4-hours, daily or weekly).
*Plan restricted. */ interval?: "1m" | "5m" | "10m" | "30m" | "1h" | "4h" | "1d" | "1w"; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { timestamp: string; net_open_interest: number; split_amount: number; merge_amount: number; split_count: number; merge_count: number; transactions: number; unique_stakeholders: number; market: { condition_id: string; market_slug: string | null; token_id: null; outcome_label: null; closed: boolean; }; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1PolymarketMarketsActivity: { parameters: { query?: { user?: string; token_id?: string; condition_id?: string; /** @description Filter by event type */ event_type?: "trade" | "split" | "merge" | "redeem"; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { event_type: string; timestamp: string; block_num: number; tx_hash: string; user: string; amount: string; value: number; fee_amount: string; fee_value: number; market: { condition_id: string | null; market_slug: string | null; token_id: string | null; outcome_label: string | null; closed: boolean; }; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1PolymarketMarketsPositions: { parameters: { query: { token_id: string; closed?: boolean; sort_by?: "position_value" | "realized_pnl" | "unrealized_pnl" | "total_pnl" | "pnl_pct" | "transactions" | "avg_price"; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { user: string; buy_cost: number; sell_revenue: number; realized_pnl: number; unrealized_pnl: number; total_pnl: number; pnl_pct: number; net_position: number; avg_price: number; current_price: number; position_value: number; active: boolean; buys: number; sells: number; transactions: number; market: { condition_id: string | null; market_slug: string | null; token_id: string; outcome_label: string | null; closed: boolean; }; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1PolymarketPlatform: { parameters: { query?: { /** @description The interval* for which to aggregate price data (1-minute, 5-minutes, 10-minutes, 30-minutes, hourly, 4-hours, daily or weekly).
*Plan restricted. */ interval?: "1m" | "5m" | "10m" | "30m" | "1h" | "4h" | "1d" | "1w"; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ start_time?: string; /** @description UNIX timestamp in seconds or date string (e.g. "2025-01-01T00:00:00Z", "2025-01-01", ...). */ end_time?: string; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { timestamp: string; volume: number; buy_volume: number; sell_volume: number; trades: number; buys: number; sells: number; net_open_interest: number; split_amount: number; merge_amount: number; split_count: number; merge_count: number; oi_transactions: number; total_fees: number; total_refunds: number; net_fees: number; fee_count: number; effective_fee_rate_gross: number; effective_fee_rate: number; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1PolymarketUsers: { parameters: { query?: { /** @description undefined
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ user?: string | string[]; /** @description Lookback window for user statistics (1 hour, 1 day, 1 week, 30 days). Omit for all-time. */ interval?: "1h" | "1d" | "1w" | "30d"; sort_by?: "total_volume" | "realized_pnl" | "unrealized_pnl" | "total_pnl" | "transactions"; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { user: string; buys: number; sells: number; transactions: number; volume_bought: number; volume_sold: number; total_volume: number; realized_pnl: number; unrealized_pnl: number; total_pnl: number; first_trade: string; last_trade: string; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1PolymarketUsersPositions: { parameters: { query: { /** @description undefined
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ user: string | string[]; /** @description undefined
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ token_id?: string | string[]; /** @description undefined
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ condition_id?: string | string[]; /** @description undefined
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ market_slug?: string | string[]; closed?: boolean; sort_by?: "position_value" | "realized_pnl" | "unrealized_pnl" | "total_pnl" | "pnl_pct" | "transactions" | "avg_price" | "current_price"; /** @description Number of items* returned in a single request.
*Plan restricted. */ limit?: number; /** @description Page number to fetch.
Empty `data` array signifies end of results. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { user: string; buy_cost: number; sell_revenue: number; realized_pnl: number; unrealized_pnl: number; total_pnl: number; pnl_pct: number; net_position: number; avg_price: number; current_price: number; position_value: number; active: boolean; buys: number; sells: number; transactions: number; market: { condition_id: string | null; market_slug: string | null; token_id: string; outcome_label: string | null; closed: boolean; }; }[]; statistics: { elapsed?: number; rows_read?: number; bytes_read?: number; }; pagination: { previous_page: number; current_page: number; }; results: number; /** @description ISO 8601 datetime string */ request_time: string; duration_ms: number; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1Health: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description All database connections are healthy */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { status: string; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; /** @description One or more database connections failed */ 503: { headers: { [name: string]: unknown; }; content: { "application/json": { status: string; error: string; }; }; }; }; }; getV1Version: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { version: string; date: string; commit: string; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getV1Networks: { parameters: { query?: { /** @description Network ID to filter by
Single value or array of values* (separate multiple values with `,`)
*Plan restricted. */ network?: string | string[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { networks: { id: string; fullName: string; shortName: string; caip2Id: string; networkType: string; icon: { web3Icons: { name: string; }; }; aliases: string[]; indexed_to: { category: string; version: string; block_num: number; datetime: string; timestamp: number; }[]; }[]; }; }; }; /** @description Client side error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Authentication failed */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 400 | 401 | 403 | 404 | 405; /** @enum {string} */ code: "authentication_failed" | "bad_header" | "missing_required_header" | "bad_query_input" | "forbidden" | "method_not_allowed" | "route_not_found" | "unauthorized" | "not_found_data"; message: string; }; }; }; /** @description Server side error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": { status: 500 | 502 | 504; /** @enum {string} */ code: "bad_database_response" | "connection_refused" | "database_timeout" | "internal_server_error"; message: string; }; }; }; }; }; getSkillsMarkdown: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "text/markdown; charset=UTF-8": string; }; }; }; }; getLlmsText: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "text/markdown; charset=UTF-8": string; }; }; }; }; getOpenapiSpec: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": Record; }; }; }; }; }