Schema

A schema defines a type system of GraphQL API. It describes the complete set of possible data (objects, fields, relationships, everything) that a client can access.

• Root types

• Non-root types

• Query types

• Subscription types

• Mutation types

• Syntax

Root types

TON Labs GraphQL schema has three root types:

• query

• mutation

• subscription

The query type defines GraphQL operations that retrieve data from the server.

The mutation type defines GraphQL operations that change data on the server. It is analogous to performing HTTP verbs such as POST, PATCH, and DELETE. Mutations are used to send messages to the blockchain. We recommend to do it only via SDK, not directly.

The subscription root type – a long‐lived request that fetches data in response to source events.

Check out EVER-SDK net module - the official EverX wrapper over GraphQL API for root queries and subscriptions.

Non-root types

See non-root type descriptions in Field descriptions section.

Query types

Root resolvers

name	description
info	Info query is used to get GraphQL API version, as well as health parameters of the API, such as latency of blocks, messages and transactions
blockchain	API that includes a set of functions for pagination of blocks, key blocks, transactions and account’s transactions and messages.
ft	Fungible Token API provides data about fungible tokens, transfers, holders.
blocks	Blocks analytics
accounts	Accounts analytics
messages	Messages analytics
transaction	Transactions analytics
blocks_signatures	Block signatures analytics
statistics	General Everscale Network statistics related to accounts, transactions, messages and blocks. And also some essential statistics about validators and depools such as total number of validators, total staked amount etc. Available only in Evercloud API.
counterparties	Returns a list of addresses the specified account interacted with, sorted by the latest interaction time (the latest message time between 2 accounts) DESC. Feature may be useful for wallet applications or for chat-based DApps to show the list of counterparties in descending order. Available only in Evercloud API.

Aggregation queries:

name	description
aggregateBlocks	Get aggregation info about blocks: COUNT, SUM, MAX, MIN, AVERAGE functions over blocks data.
aggregateTransactions	Get aggregation info about transactions: COUNT, SUM, MAX, MIN, AVERAGE functions over transactions data.
aggregateMessages	Get aggregation info about messages: COUNT, SUM, MAX, MIN, AVERAGE functions over messages data.
aggregateAccounts	Get aggregation info about accounts: COUNT, SUM, MAX, MIN, AVERAGE functions over accounts data.
aggregateBlockSignatures	Get aggregation info about block signaturess: COUNT, SUM, MAX, MIN, AVERAGE functions over block signatures data.

Subscription types

• blocks

• accounts

• messages

• transaction

• blocks_signatures

• counterparties

• rempReceipts - subscription for REMP processing status receipts of a message (by messageId)

Mutation types

• postRequests - used to send messages to blockchain.

Syntax

Read about GraphQL syntax in its official documentation. In this example we query account info:

query {
  blockchain{
   account(address:"0:653b9a6452c7a982c6dc92b2da9eba832ade1c467699ebb3b43dca6d77b780dd"){
    info{
      address
      acc_type
      balance
      last_paid
      last_trans_lt
      boc
      data
      code
      library
      data_hash
      code_hash
      library_hash
    }
    transactions(last:1){
      edges{
        node{
          hash
          now
          balance_delta
        }
      }
    }
  }
  }
}

Here you can see a request for account's information and the last transaction with a subset of fields. All available fields with their descriptions can be found in data schema in playground.

A selection set must contain only scalar fields, otherwise you will get an error. A scalar field describes one discrete piece of information available to a request within a selection set. If field is an object, you need to specify the fields of this object.

Read more in the next sections.