API Queries Glossary
Explore further about the Enjin Platform queries.
The Enjin Platform API is built on GraphQL, enabling users to execute a diverse set of queries to retrieve blockchain data. This approach facilitates interaction with blockchain collections without requiring specialized blockchain programming knowledge.
The Enjin Platform API queries are divided into collections, users, wallets, and miscellaneous categories. These queries are designed to fetch blockchain information using GraphQL as a foundation, making it simple for non-expert developers to interact with blockchain collections. You can find these queries in the GraphiQL schema within your environment using the query and mutation builder. The following tables display all of these queries.
Here is a table of the queries and their descriptions:
Query Name | Description |
---|---|
GetBlocks | Get an array of blockchain blocks, optionally filtered by transaction IDs or hashes. |
GetCollection | Get a single collection by its collection ID. |
GetCollections | Get an array of collections, optionally filtered by collection IDs. |
GetToken | Get a single token from a collection using its token ID. |
GetTokens | Get an array of tokens from a collection, optionally filtered by token IDs. |
GetTransaction | Get a single transaction using its database ID, on-chain transaction ID or transaction hash. |
GetTransactions | Get an array of transactions, optionally filtered by various parameters such as transaction IDs, transaction hashes, methods, states, results or accounts. |
GetWallet | Get a wallet using either its database ID, external ID, verification ID or account address. |
GetWallets | Get an array of wallets, optionally filtered by various parameters such as external IDs, verification IDs or account addresses. |
VerifyMessage | Verify a message was signed with the provided public key and signature. |
GetAccountVerified | Get the verification status of an account. |
GetLinkingCode | Create a new linking code to associate an external ID to a wallet account. |
GetPendingEvents | Get a list of events that were broadcast but not yet acknowledged. |
GetPendingWallets | Get an array of wallet accounts that have yet to be verified. |
RequestAccount | Generate a QR code that the user can scan to provide their wallet account. |
Query Name | Description |
---|---|
GetBeam | Get beam details by its code and optional account. |
GetBeams | Get an array of beam details optionally filtered by codes or names. |
GetClaims | Get an array of claim details optionally filtered by ids, codes, accounts, or states. |
GetSingleUseCodes | Get an array of single-use code details by its code, optionally filtered by after and first. |
Query | Description |
---|---|
GetAccounts | Get an array of account details of who is taking part in the fuel tank created by you. |
GetFuelTank | Get fuel tank details based on its name or fuel tank Id. |
GetFuelTanks | Get an array of fuel tank details based on their names or tank ids. |
Query Name | Description |
---|---|
GetBid | Get the market listing bid. |
GetBids | Get the market listing bids. |
GetListing | Get a single market listing. |
GetListings | Get multiple market listings. |
GetSale | Get the market listing sale. |
GetSales | Get the market listing sales. |
Last modified 2mo ago