Skip to content
/
Token

GraphQL Overview

Download GraphQL schema
index.graphql

Queries

Overview

Subscriptions

Overview

Directives

Overview

Objects

Overview

KeysetGuard

A keyset guard.

keys
[String!]!,non-null
predicate
String!,non-null
raw
String!,non-null

Implements interfaces

IGuard

A guard. This is a union of all the different types of guards that can be used in a pact.

Sample
{
  "keys": [
    "Example String"
  ],
  "predicate": "Example String",
  "raw": "Example String"
}

UserGuard

args
[String!]!,non-null
fun
String!,non-null
keys
[String!]!,non-nulldeprecated
Deprecation reason

deprecated, use KeysetGuard.keys

predicate
String!,non-nulldeprecated
Deprecation reason

deprecated, use KeysetGuard.predicate

raw
String!,non-null

Implements interfaces

IGuard

A guard. This is a union of all the different types of guards that can be used in a pact.

Sample
{
  "args": [
    "Example String"
  ],
  "fun": "Example String",
  "keys": [
    "Example String"
  ],
  "predicate": "Example String",
  "raw": "Example String"
}

RawGuard

DEPRECATED: a fallthrough IGuard type to cover non-KeysetGuard types.

keys
[String!]!,non-nulldeprecated
Deprecation reason

deprecated, use KeysetGuard.keys

predicate
String!,non-nulldeprecated
Deprecation reason

deprecated, use KeysetGuard.predicate

raw
String!,non-null

Implements interfaces

IGuard

A guard. This is a union of all the different types of guards that can be used in a pact.

Sample
{
  "keys": [
    "Example String"
  ],
  "predicate": "Example String",
  "raw": "Example String"
}

QueryTokensConnection

edges
[QueryTokensEdge!]!,non-null
pageInfo
PageInfo!,non-null
Sample
{
  "edges": [
    {
      "cursor": "Example String",
      "node": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "name": "Example String",
        "chainId": "Example String",
        "address": "Example String"
      }
    }
  ],
  "pageInfo": {
    "startCursor": "Example String",
    "endCursor": "Example String",
    "hasNextPage": true,
    "hasPreviousPage": true
  }
}

QueryTokensEdge

cursor
String!,non-null
node
Token!,non-null
Sample
{
  "cursor": "Example String",
  "node": {
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "name": "Example String",
    "chainId": "Example String",
    "address": "Example String"
  }
}
Referenced in
QueryTokensConnection.edges

Token

id
ID!,non-null
name
String!,non-null
chainId
String!,non-null
address
String
Sample
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "name": "Example String",
  "chainId": "Example String",
  "address": "Example String"
}
Referenced in
QueryTokensEdge.node
Pool.token0
Pool.token1
TokenPrice.token

Pool

Represents an automated market maker (AMM) liquidity pool for a pair of tokens.

A Pool tracks on-chain reserves, liquidity (LP) supply, pricing-derived metrics (TVL, volume, fees), and short-term performance indicators (24h / 7d deltas). Prices used to compute TVL/volume/fees are sourced from DIA and refreshed periodically. Use this type to power pool lists, detail pages, analytics dashboards, and historical charts.

Note: Numeric reserve and supply values are returned as strings to preserve precision.

id
ID!,non-null

Globally unique identifier for this pool node.

address
String!,non-null

The on-chain address / module reference for this pool.

token0
Token!,non-null

The first token in the pair (base/slot-0).

token1
Token!,non-null

The second token in the pair (quote/slot-1).

reserve0
String!,non-null

Current on-chain reserve of token0 held by the pool (as a string for full precision).

reserve1
String!,non-null

Current on-chain reserve of token1 held by the pool (as a string for full precision).

totalSupply
String!,non-null

Total supply of the pool’s LP (liquidity provider) tokens (as a string for full precision).

key
String!,non-null

A stable key for the pool (e.g., a deterministic pair identifier).

tvlUsd
Float!,non-null

Total value locked (USD) in this pool, derived from reserves and external pricing.

tvlChange24h
Float!,non-null

24-hour percentage change in TVL.

volume24hUsd
Float!,non-null

Notional 24-hour traded volume (USD).

volumeChange24h
Float!,non-null

24-hour percentage change in volume.

volume7dUsd
Float!,non-null

Notional 7-day traded volume (USD).

fees24hUsd
Float!,non-null

Notional 24-hour fees accrued by the pool (USD).

feesChange24h
Float!,non-null

24-hour percentage change in fees.

transactionCount24h
Int!,non-null

Count of pool transactions over the last 24 hours.

transactionCountChange24h
Float!,non-null

24-hour percentage change in transaction count.

apr24h
Float!,non-null

24-hour APR estimate derived from recent fees relative to TVL (as a percentage).

createdAt
DateTime!,non-null

Timestamp when this pool record was created.

updatedAt
DateTime!,non-null

Timestamp when this pool record was last updated.

charts
PoolCharts!,non-null

Get chart/series data for this pool over a specified timeframe (e.g., TVL, volume).

timeFrame*
transactions
PoolTransactionsConnection

Get transactions related to this pool, with optional type filtering and cursor-based pagination.

typefirstafterlastbefore

Implements interfaces

Node

A globally identifiable object in the GraphQL schema.

All core entities in this API implement the Node interface, which guarantees that they have a unique id field, enabling consistent caching, pagination, and reference resolution across the API.

Sample
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "address": "Example String",
  "token0": {
    "__typename": "Token"
  },
  "token1": {
    "__typename": "Token"
  },
  "reserve0": "Example String",
  "reserve1": "Example String",
  "totalSupply": "Example String",
  "key": "Example String",
  "tvlUsd": 40,
  "tvlChange24h": 40,
  "volume24hUsd": 40,
  "volumeChange24h": 40,
  "volume7dUsd": 40,
  "fees24hUsd": 40,
  "feesChange24h": 40,
  "transactionCount24h": 40,
  "transactionCountChange24h": 40,
  "apr24h": 40,
  "createdAt": "Example Custom Scalar",
  "updatedAt": "Example Custom Scalar",
  "charts": {
    "__typename": "PoolCharts"
  },
  "transactions": {
    "__typename": "PoolTransactionsConnection"
  }
}
Referenced in
QueryPoolsConnectionEdge.node
LiquidityBalance.pair
LiquidityPosition.pair

QueryPoolsConnection

edges
[QueryPoolsConnectionEdge!]!,non-null
pageInfo
PageInfo!,non-null
totalCount
Int!,non-null
Sample
{
  "edges": [
    {
      "cursor": "Example String",
      "node": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "address": "Example String",
        "token0": {
          "__typename": "Token"
        },
        "token1": {
          "__typename": "Token"
        },
        "reserve0": "Example String",
        "reserve1": "Example String",
        "totalSupply": "Example String",
        "key": "Example String",
        "tvlUsd": 40,
        "tvlChange24h": 40,
        "volume24hUsd": 40,
        "volumeChange24h": 40,
        "volume7dUsd": 40,
        "fees24hUsd": 40,
        "feesChange24h": 40,
        "transactionCount24h": 40,
        "transactionCountChange24h": 40,
        "apr24h": 40,
        "createdAt": "Example Custom Scalar",
        "updatedAt": "Example Custom Scalar",
        "charts": {
          "__typename": "PoolCharts"
        },
        "transactions": {
          "__typename": "PoolTransactionsConnection"
        }
      }
    }
  ],
  "pageInfo": {
    "startCursor": "Example String",
    "endCursor": "Example String",
    "hasNextPage": true,
    "hasPreviousPage": true
  },
  "totalCount": 40
}

QueryPoolsConnectionEdge

cursor
String!,non-null
node
Pool!,non-null
Sample
{
  "cursor": "Example String",
  "node": {
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "address": "Example String",
    "token0": {
      "__typename": "Token"
    },
    "token1": {
      "__typename": "Token"
    },
    "reserve0": "Example String",
    "reserve1": "Example String",
    "totalSupply": "Example String",
    "key": "Example String",
    "tvlUsd": 40,
    "tvlChange24h": 40,
    "volume24hUsd": 40,
    "volumeChange24h": 40,
    "volume7dUsd": 40,
    "fees24hUsd": 40,
    "feesChange24h": 40,
    "transactionCount24h": 40,
    "transactionCountChange24h": 40,
    "apr24h": 40,
    "createdAt": "Example Custom Scalar",
    "updatedAt": "Example Custom Scalar",
    "charts": {
      "__typename": "PoolCharts"
    },
    "transactions": {
      "__typename": "PoolTransactionsConnection"
    }
  }
}
Referenced in
QueryPoolsConnection.edges

PoolTransaction

A swap transaction in a pool

id
ID!,non-null

Unique identifier

maker
String!,non-null

User who made the swap

amount0In
Decimal!,non-null

Amount of token0 swapped in

amount1In
Decimal!,non-null

Amount of token1 swapped in

amount0Out
Decimal!,non-null

Amount of token0 swapped out

amount1Out
Decimal!,non-null

Amount of token1 swapped out

amountUsd
Decimal!,non-null

Total amount in USD

timestamp
DateTime!,non-null

Transaction timestamp

transactionId
Int

ID of the transaction

requestkey
String!,non-null

Request key of the transaction

transactionType
PoolTransactionType!,non-null

The type of transaction

Sample
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "maker": "Example String",
  "amount0In": "Example Custom Scalar",
  "amount1In": "Example Custom Scalar",
  "amount0Out": "Example Custom Scalar",
  "amount1Out": "Example Custom Scalar",
  "amountUsd": "Example Custom Scalar",
  "timestamp": "Example Custom Scalar",
  "transactionId": 40,
  "requestkey": "Example String",
  "transactionType": "SWAP"
}
Referenced in
PoolTransactionEdge.node

PoolTransactionsConnection

Connection type for pool transactions

edges
[PoolTransactionEdge!],non-null

List of transaction edges

pageInfo
PageInfo

Pagination information

totalCount
Int

Total number of transactions

Sample
{
  "edges": [
    {
      "cursor": "Example String",
      "node": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "maker": "Example String",
        "amount0In": "Example Custom Scalar",
        "amount1In": "Example Custom Scalar",
        "amount0Out": "Example Custom Scalar",
        "amount1Out": "Example Custom Scalar",
        "amountUsd": "Example Custom Scalar",
        "timestamp": "Example Custom Scalar",
        "transactionId": 40,
        "requestkey": "Example String",
        "transactionType": "SWAP"
      }
    }
  ],
  "pageInfo": {
    "startCursor": "Example String",
    "endCursor": "Example String",
    "hasNextPage": true,
    "hasPreviousPage": true
  },
  "totalCount": 40
}
Referenced in
Pool.transactions

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview