Schema
Last updated
Last updated
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.
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.
See non-root type descriptions in Field descriptions section.
Root resolvers
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
API that includes a set of functions for pagination of blocks, key blocks, transactions and account’s transactions and messages.
Fungible Token API provides data about fungible tokens, transfers, holders.
Blocks analytics
Accounts analytics
Messages analytics
Transactions analytics
blocks_signatures
Block signatures analytics
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.
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:
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.
blocks
accounts
messages
transaction
blocks_signatures
counterparties
rempReceipts - subscription for REMP processing status receipts of a message (by messageId)
postRequests - used to send messages to blockchain.
Read about GraphQL syntax in its official documentation
. In this example we query account info:
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.