Buildo Expert
Buildo Expert · Acciones GPT
Multiversx API
The API is built to allow you to create apps or integrations quickly and easily. This API is organized around REST principles, so if you've interacted with RESTful APIs before, many of the concepts will look familiar. ## Request * Requests with a message body use JSON. Successful requests will return a `2xx` HTTP status. ## Response * JSON will be returned for all responses, including errors. ## Parameters * Some endpoints accept optional parameters which can be passed as query string params. * All parameters are documented along each endpoint. ## Complexity * In order to better optimize the available resources, a complexity evaluation is performed before the execution of every request. * The maximum complexity available is currently hardcoded at `10000` * When listing entries, every element in the list adds `1` to the complexity, thus making it possible to retrieve a maximum of `10000` elements in list endpoints. * If some extra info is requested, such as `withScResults` in the `/transactions` endpoint, the complexity calculation for the list is overridden with the complexity calculation of the requested field. In this situation, `withScResults` will multiply the number of items with `200`, thus limiting the maximum requested size to `50` * Some fields use the same amount of resources whether one or more of them are requested. In this situation, the fields will be grouped together, regardless whether one or more of the same group are requested. The endpoints `/transactions?size=50&withOperations=true` will produce the same complexity as `/transactions?size=50&withOperations=true&withLogs=true&withScResults=true` since they all belong to the group `details` ## Fields * In order to fetch only specific fields from the response, the `fields` parameter can be used: * `/accounts?fields=address,balance for arrays` * `/economics?fields=price,marketCap for object` ## Extract * In order to extract a scalar value from an object response, the `extract` parameter can be used: * `/economics?extract=price` ## Cleanup * If the value of an attribute is `undefined`, `""` (empty string), `null`, `[ ]` (empty array) the attribute will be omitted. ## Pagination * Requests that return multiple items will be paginated to 25 items by default. * For a different number of items or for the next pages `?from=` and `size=` can be used.
GET /accountsAccounts detailsReturns all accounts available on blockchain. By default it returns 25 accounts
GET /accounts/countTotal number of accountsReturns total number of accounts available on blockchain
GET /accounts/{address}Account detailsReturns account details for a given address
GET /accounts/{address}/tokensAccount tokensReturns a list of all available fungible tokens for a given address, together with their balance
GET /accounts/{address}/tokens/countAccount token countReturns the total number of tokens for a given address
GET /accounts/{address}/tokens/{token}Account token detailsReturns details about a specific fungible token from a given address
GET /accounts/{address}/collectionsAccount collectionsReturns NFT/SFT/MetaESDT collections where the account owns one or more NFTs
GET /accounts/{address}/collections/{collection}Account collection detailsReturns details about a specific NFT/SFT/MetaESDT collection from a given address
GET /accounts/{address}/nftsAccount NFTsReturns a list of all available NFTs/SFTs/MetaESDTs owned by the provided address
GET /accounts/{address}/nfts/countAccount NFT/SFT tokens countReturns the total number of NFT/SFT tokens from a given address, as well as the total number of a certain type of ESDT
GET /accounts/{address}/nfts/{nft}Account NFT/SFT token detailsReturns details about a specific fungible token for a given address
GET /accounts/{address}/transactionsAccount transaction listReturns details of all transactions where the account is sender or receiver
GET /accounts/{address}/contractsAccount smart contracts detailsReturns smart contracts details for a given account
GET /collections/{collection}/nftsCollection NFTsReturns non-fungible/semi-fungible/meta-esdt tokens that belong to a collection
GET /collections/{collection}/nfts/countCollection NFT countReturns non-fungible/semi-fungible/meta-esdt token count that belong to a collection
GET /collections/{identifier}/accountsCollection accountsReturns a list of addresses and balances for a specific collection
GET /collections/{collection}/transactionsCollection transactionsReturns a list of transactions for a specific collection.
GET /nfts/{identifier}NFT detailsReturns the details of an Non-Fungible / Semi-Fungible / MetaESDT token for a given identifier
GET /nfts/{identifier}/accountsNFT accountsReturns a list of addresses that hold balances for a specific Non-Fungible / Semi-Fungible / MetaESDT token
GET /nfts/{identifier}/accounts/countNFT accounts countReturns number of addresses that hold balances for a specific Non-Fungible / Semi-Fungible / MetaESDT token
GET /nfts/{identifier}/transactionsNFT transactionsReturns a list of transactions for a NonFungibleESDT or SemiFungibleESDT.
GET /tokens/{identifier}TokenReturns token details based on a specific token identifier
GET /tokens/{identifier}/accountsToken accountsReturns a list of accounts that hold a specific token
GET /tokens/{identifier}/accounts/countToken accounts countReturns the total number of accounts that hold a specific token
GET /tokens/{identifier}/transactionsToken transactionsReturns a list of transactions for a specific token.
GET /transactions/{txHash}Transaction detailsReturn transaction details for a given transaction hash
GET /usernames/{username}Account details by usernameReturns account details for a given username. Performs a redirect on the proper account address
Esquema original API
{
"openapi": "3.0.0",
"paths": {
"/accounts": {
"get": {
"operationId": "AccountController_getAccounts",
"summary": "Accounts details",
"description": "Returns all accounts available on blockchain. By default it returns 25 accounts",
"parameters": [
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
},
{
"name": "ownerAddress",
"required": false,
"in": "query",
"description": "Search by owner address",
"schema": {
"type": "string"
}
},
{
"name": "sort",
"required": false,
"in": "query",
"description": "Sort criteria (balance / timestamp)",
"schema": {
"enum": [
"balance",
"timestamp"
],
"type": "string"
}
},
{
"name": "order",
"required": false,
"in": "query",
"description": "Sort order (asc/desc)",
"schema": {
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
{
"name": "isSmartContract",
"required": false,
"in": "query",
"description": "Return a list of smart contracts",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/count": {
"get": {
"operationId": "AccountController_getAccountsCount",
"summary": "Total number of accounts",
"description": "Returns total number of accounts available on blockchain",
"parameters": [
{
"name": "ownerAddress",
"required": false,
"in": "query",
"description": "Search by owner address",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}": {
"get": {
"operationId": "AccountController_getAccountDetails",
"summary": "Account details",
"description": "Returns account details for a given address",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "withGuardianInfo",
"required": false,
"in": "query",
"description": "Returns guardian data for a given address",
"schema": {
"type": "boolean"
}
},
{
"name": "fields",
"required": false,
"in": "query",
"description": "List of fields to filter by",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}/tokens": {
"get": {
"operationId": "AccountController_getAccountTokens",
"summary": "Account tokens",
"description": "Returns a list of all available fungible tokens for a given address, together with their balance",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
},
{
"name": "type",
"required": false,
"in": "query",
"description": "Token type",
"schema": {
"enum": [
"FungibleESDT",
"MetaESDT"
],
"type": "string"
}
},
{
"name": "search",
"required": false,
"in": "query",
"description": "Search by collection identifier",
"schema": {
"type": "string"
}
},
{
"name": "name",
"required": false,
"in": "query",
"description": "Search by token name",
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"required": false,
"in": "query",
"description": "Search by token identifier",
"schema": {
"type": "string"
}
},
{
"name": "identifiers",
"required": false,
"in": "query",
"description": "A comma-separated list of identifiers to filter by",
"schema": {
"type": "string"
}
},
{
"name": "includeMetaESDT",
"required": false,
"in": "query",
"description": "Include MetaESDTs in response",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}/tokens/count": {
"get": {
"operationId": "AccountController_getTokenCount",
"summary": "Account token count",
"description": "Returns the total number of tokens for a given address",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "type",
"required": false,
"in": "query",
"description": "Token type",
"schema": {
"enum": [
"FungibleESDT",
"MetaESDT"
],
"type": "string"
}
},
{
"name": "search",
"required": false,
"in": "query",
"description": "Search by collection identifier",
"schema": {
"type": "string"
}
},
{
"name": "name",
"required": false,
"in": "query",
"description": "Search by token name",
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"required": false,
"in": "query",
"description": "Search by token identifier",
"schema": {
"type": "string"
}
},
{
"name": "identifiers",
"required": false,
"in": "query",
"description": "A comma-separated list of identifiers to filter by",
"schema": {
"type": "string"
}
},
{
"name": "includeMetaESDT",
"required": false,
"in": "query",
"description": "Include MetaESDTs in response",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}/tokens/{token}": {
"get": {
"operationId": "AccountController_getAccountToken",
"summary": "Account token details",
"description": "Returns details about a specific fungible token from a given address",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "token",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}/collections": {
"get": {
"operationId": "AccountController_getAccountNftCollections",
"summary": "Account collections",
"description": "Returns NFT/SFT/MetaESDT collections where the account owns one or more NFTs",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
},
{
"name": "search",
"required": false,
"in": "query",
"description": "Search by collection identifier",
"schema": {
"type": "string"
}
},
{
"name": "type",
"required": false,
"in": "query",
"description": "Filter by type (NonFungibleESDT/SemiFungibleESDT/MetaESDT)",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "excludeMetaESDT",
"required": false,
"in": "query",
"description": "Exclude collections of type \"MetaESDT\" in the response",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}/collections/{collection}": {
"get": {
"operationId": "AccountController_getAccountNftCollection",
"summary": "Account collection details",
"description": "Returns details about a specific NFT/SFT/MetaESDT collection from a given address",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "collection",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}/nfts": {
"get": {
"operationId": "AccountController_getAccountNfts",
"summary": "Account NFTs",
"description": "Returns a list of all available NFTs/SFTs/MetaESDTs owned by the provided address",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
},
{
"name": "search",
"required": false,
"in": "query",
"description": "Search by collection identifier",
"schema": {
"type": "string"
}
},
{
"name": "identifiers",
"required": false,
"in": "query",
"description": "Filter by identifiers, comma-separated",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "type",
"required": false,
"in": "query",
"description": "Filter by type (NonFungibleESDT/SemiFungibleESDT/MetaESDT)",
"schema": {
"type": "string"
}
},
{
"name": "collection",
"required": false,
"in": "query",
"description": "Get all tokens by token collection. Deprecated, replaced by collections parameter",
"deprecated": true,
"schema": {
"type": "string"
}
},
{
"name": "collections",
"required": false,
"in": "query",
"description": "Get all tokens by token collections, comma-separated",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "name",
"required": false,
"in": "query",
"description": "Get all nfts by name",
"schema": {
"type": "string"
}
},
{
"name": "tags",
"required": false,
"in": "query",
"description": "Filter by one or more comma-separated tags",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "creator",
"required": false,
"in": "query",
"description": "Return all NFTs associated with a given creator",
"schema": {
"type": "string"
}
},
{
"name": "hasUris",
"required": false,
"in": "query",
"description": "Return all NFTs that have one or more uris",
"schema": {
"type": "boolean"
}
},
{
"name": "includeFlagged",
"required": false,
"in": "query",
"description": "Include NFTs that are flagged or not",
"schema": {
"type": "boolean"
}
},
{
"name": "withSupply",
"required": false,
"in": "query",
"description": "Return supply where type = SemiFungibleESDT",
"schema": {
"type": "boolean"
}
},
{
"name": "withScamInfo",
"required": false,
"in": "query",
"description": "Include scam info in the response",
"schema": {
"type": "boolean"
}
},
{
"name": "computeScamInfo",
"required": false,
"in": "query",
"description": "Compute scam info in the response",
"schema": {
"type": "boolean"
}
},
{
"name": "source",
"required": false,
"in": "query",
"description": "Data source of request",
"schema": {
"type": "string"
}
},
{
"name": "excludeMetaESDT",
"required": false,
"in": "query",
"description": "Exclude NFTs of type \"MetaESDT\" in the response",
"schema": {
"type": "boolean"
}
},
{
"name": "fields",
"required": false,
"in": "query",
"description": "List of fields to filter by",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}/nfts/count": {
"get": {
"operationId": "AccountController_getNftCount",
"summary": "Account NFT/SFT tokens count",
"description": "Returns the total number of NFT/SFT tokens from a given address, as well as the total number of a certain type of ESDT ",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "identifiers",
"required": false,
"in": "query",
"description": "Filter by identifiers, comma-separated",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "search",
"required": false,
"in": "query",
"description": "Search by collection identifier",
"schema": {
"type": "string"
}
},
{
"name": "type",
"required": false,
"in": "query",
"description": "Filter by type (NonFungibleESDT/SemiFungibleESDT/MetaESDT)",
"schema": {
"type": "string"
}
},
{
"name": "collection",
"required": false,
"in": "query",
"description": "Get all tokens by token collection",
"schema": {
"type": "string"
}
},
{
"name": "collections",
"required": false,
"in": "query",
"description": "Get all tokens by token collections, comma-separated",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "name",
"required": false,
"in": "query",
"description": "Get all nfts by name",
"schema": {
"type": "string"
}
},
{
"name": "tags",
"required": false,
"in": "query",
"description": "Filter by one or more comma-separated tags",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "creator",
"required": false,
"in": "query",
"description": "Return all NFTs associated with a given creator",
"schema": {
"type": "string"
}
},
{
"name": "hasUris",
"required": false,
"in": "query",
"description": "Return all NFTs that have one or more uris",
"schema": {
"type": "boolean"
}
},
{
"name": "includeFlagged",
"required": false,
"in": "query",
"description": "Include NFTs that are flagged or not",
"schema": {
"type": "boolean"
}
},
{
"name": "excludeMetaESDT",
"required": false,
"in": "query",
"description": "Exclude NFTs of type \"MetaESDT\" in the response",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}/nfts/{nft}": {
"get": {
"operationId": "AccountController_getAccountNft",
"summary": "Account NFT/SFT token details",
"description": "Returns details about a specific fungible token for a given address",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "nft",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "fields",
"required": false,
"in": "query",
"description": "List of fields to filter by",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "extract",
"required": false,
"in": "query",
"description": "Extract a specific field",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}/transactions": {
"get": {
"operationId": "AccountController_getAccountTransactions",
"summary": "Account transaction list",
"description": "Returns details of all transactions where the account is sender or receiver",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
},
{
"name": "sender",
"required": false,
"in": "query",
"description": "Address of the transaction sender",
"schema": {
"type": "string"
}
},
{
"name": "receiver",
"required": false,
"in": "query",
"description": "Search by multiple receiver addresses, comma-separated",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "token",
"required": false,
"in": "query",
"description": "Identifier of the token",
"schema": {
"type": "string"
}
},
{
"name": "senderShard",
"required": false,
"in": "query",
"description": "Id of the shard the sender address belongs to",
"schema": {
"type": "number"
}
},
{
"name": "receiverShard",
"required": false,
"in": "query",
"description": "Id of the shard the receiver address belongs to",
"schema": {
"type": "number"
}
},
{
"name": "miniBlockHash",
"required": false,
"in": "query",
"description": "Filter by miniblock hash",
"schema": {
"type": "string"
}
},
{
"name": "hashes",
"required": false,
"in": "query",
"description": "Filter by a comma-separated list of transaction hashes",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "status",
"required": false,
"in": "query",
"description": "Status of the transaction (success / pending / invalid / fail)",
"schema": {
"enum": [
"success",
"pending",
"invalid",
"fail"
],
"type": "string"
}
},
{
"name": "function",
"required": false,
"in": "query",
"description": "Filter transactions by function name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "before",
"required": false,
"in": "query",
"description": "Before timestamp",
"schema": {
"type": "number"
}
},
{
"name": "after",
"required": false,
"in": "query",
"description": "After timestamp",
"schema": {
"type": "number"
}
},
{
"name": "order",
"required": false,
"in": "query",
"description": "Sort order (asc/desc)",
"schema": {
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
{
"name": "fields",
"required": false,
"in": "query",
"description": "List of fields to filter by",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "withScResults",
"required": false,
"in": "query",
"description": "Return scResults for transactions. When \"withScresults\" parameter is applied, complexity estimation is 200",
"schema": {
"type": "boolean"
}
},
{
"name": "withOperations",
"required": false,
"in": "query",
"description": "Return operations for transactions. When \"withOperations\" parameter is applied, complexity estimation is 200",
"schema": {
"type": "boolean"
}
},
{
"name": "withLogs",
"required": false,
"in": "query",
"description": "Return logs for transactions. When \"withLogs\" parameter is applied, complexity estimation is 200",
"schema": {
"type": "boolean"
}
},
{
"name": "withScamInfo",
"required": false,
"in": "query",
"description": "Returns scam information",
"schema": {
"type": "boolean"
}
},
{
"name": "withUsername",
"required": false,
"in": "query",
"description": "Integrates username in assets for all addresses present in the transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withBlockInfo",
"required": false,
"in": "query",
"description": "Returns sender / receiver block details",
"schema": {
"type": "boolean"
}
},
{
"name": "senderOrReceiver",
"required": false,
"in": "query",
"description": "One address that current address interacted with",
"schema": {
"type": "string"
}
},
{
"name": "isRelayed",
"required": false,
"in": "query",
"description": "Returns isRelayed transactions details",
"schema": {
"type": "boolean"
}
},
{
"name": "computeScamInfo",
"required": false,
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}/contracts": {
"get": {
"operationId": "AccountController_getAccountContracts",
"summary": "Account smart contracts details",
"description": "Returns smart contracts details for a given account",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/collections/{collection}/nfts": {
"get": {
"operationId": "CollectionController_getNfts",
"summary": "Collection NFTs",
"description": "Returns non-fungible/semi-fungible/meta-esdt tokens that belong to a collection",
"parameters": [
{
"name": "collection",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
},
{
"name": "search",
"required": false,
"in": "query",
"description": "Search by collection identifier",
"schema": {
"type": "string"
}
},
{
"name": "identifiers",
"required": false,
"in": "query",
"description": "Search by token identifiers, comma-separated",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "name",
"required": false,
"in": "query",
"description": "Get all nfts by name",
"schema": {
"type": "string"
}
},
{
"name": "tags",
"required": false,
"in": "query",
"description": "Filter by one or more comma-separated tags",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "creator",
"required": false,
"in": "query",
"description": "Return all NFTs associated with a given creator",
"schema": {
"type": "string"
}
},
{
"name": "isWhitelistedStorage",
"required": false,
"in": "query",
"description": "Return all NFTs that are whitelisted in storage",
"schema": {
"type": "boolean"
}
},
{
"name": "hasUris",
"required": false,
"in": "query",
"description": "Return all NFTs that have one or more uris",
"schema": {
"type": "boolean"
}
},
{
"name": "isNsfw",
"required": false,
"in": "query",
"description": "Filter by NSFW status",
"schema": {
"type": "boolean"
}
},
{
"name": "nonceBefore",
"required": false,
"in": "query",
"description": "Return all NFTs with given nonce before the given number",
"schema": {
"type": "number"
}
},
{
"name": "nonceAfter",
"required": false,
"in": "query",
"description": "Return all NFTs with given nonce after the given number",
"schema": {
"type": "number"
}
},
{
"name": "withOwner",
"required": false,
"in": "query",
"description": "Return owner where type = NonFungibleESDT",
"schema": {
"type": "boolean"
}
},
{
"name": "withSupply",
"required": false,
"in": "query",
"description": "Return supply where type = SemiFungibleESDT",
"schema": {
"type": "boolean"
}
},
{
"name": "withScamInfo",
"required": false,
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "computeScamInfo",
"required": false,
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort",
"required": false,
"in": "query",
"description": "Sorting criteria",
"schema": {
"enum": [
"timestamp",
"rank",
"nonce"
],
"type": "string"
}
},
{
"name": "order",
"required": false,
"in": "query",
"description": "Sorting order (asc / desc)",
"schema": {
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
{
"name": "traits",
"required": false,
"in": "query",
"description": "Filter NFTs by traits. Key-value format (<key1>:<value1>;<key2>:<value2>)",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"collections"
]
}
},
"/collections/{collection}/nfts/count": {
"get": {
"operationId": "CollectionController_getNftCount",
"summary": "Collection NFT count",
"description": "Returns non-fungible/semi-fungible/meta-esdt token count that belong to a collection",
"parameters": [
{
"name": "collection",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "search",
"required": false,
"in": "query",
"description": "Search by collection identifier",
"schema": {
"type": "string"
}
},
{
"name": "identifiers",
"required": false,
"in": "query",
"description": "Search by token identifiers, comma-separated",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "name",
"required": false,
"in": "query",
"description": "Get all nfts by name",
"schema": {
"type": "string"
}
},
{
"name": "tags",
"required": false,
"in": "query",
"description": "Filter by one or more comma-separated tags",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "creator",
"required": false,
"in": "query",
"description": "Return all NFTs associated with a given creator",
"schema": {
"type": "string"
}
},
{
"name": "isWhitelistedStorage",
"required": false,
"in": "query",
"description": "Return all NFTs that are whitelisted in storage",
"schema": {
"type": "boolean"
}
},
{
"name": "hasUris",
"required": false,
"in": "query",
"description": "Return all NFTs that have one or more uris",
"schema": {
"type": "boolean"
}
},
{
"name": "nonceBefore",
"required": false,
"in": "query",
"description": "Return all NFTs with given nonce before the given number",
"schema": {
"type": "number"
}
},
{
"name": "nonceAfter",
"required": false,
"in": "query",
"description": "Return all NFTs with given nonce after the given number",
"schema": {
"type": "number"
}
},
{
"name": "traits",
"required": false,
"in": "query",
"description": "Filter NFTs by traits. Key-value format (<key1>:<value1>;<key2>:<value2>)",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"collections"
]
}
},
"/collections/{identifier}/accounts": {
"get": {
"operationId": "CollectionController_getNftAccounts",
"summary": "Collection accounts",
"description": "Returns a list of addresses and balances for a specific collection",
"parameters": [
{
"name": "identifier",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"collections"
]
}
},
"/collections/{collection}/transactions": {
"get": {
"operationId": "CollectionController_getCollectionTransactions",
"summary": "Collection transactions",
"description": "Returns a list of transactions for a specific collection.",
"parameters": [
{
"name": "collection",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
},
{
"name": "sender",
"required": false,
"in": "query",
"description": "Address of the transaction sender",
"schema": {
"type": "string"
}
},
{
"name": "receiver",
"required": false,
"in": "query",
"description": "Search by multiple receiver addresses, comma-separated",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "senderShard",
"required": false,
"in": "query",
"description": "Id of the shard the sender address belongs to",
"schema": {
"type": "number"
}
},
{
"name": "receiverShard",
"required": false,
"in": "query",
"description": "Id of the shard the receiver address belongs to",
"schema": {
"type": "number"
}
},
{
"name": "miniBlockHash",
"required": false,
"in": "query",
"description": "Filter by miniblock hash",
"schema": {
"type": "string"
}
},
{
"name": "hashes",
"required": false,
"in": "query",
"description": "Filter by a comma-separated list of transaction hashes",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "status",
"required": false,
"in": "query",
"description": "Status of the transaction (success / pending / invalid / fail)",
"schema": {
"enum": [
"success",
"pending",
"invalid",
"fail"
],
"type": "string"
}
},
{
"name": "function",
"required": false,
"in": "query",
"description": "Filter transactions by function name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "before",
"required": false,
"in": "query",
"description": "Before timestamp",
"schema": {
"type": "number"
}
},
{
"name": "after",
"required": false,
"in": "query",
"description": "After timestamp",
"schema": {
"type": "number"
}
},
{
"name": "order",
"required": false,
"in": "query",
"description": "Sort order (asc/desc)",
"schema": {
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
{
"name": "withScResults",
"required": false,
"in": "query",
"description": "Return scResults for transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withOperations",
"required": false,
"in": "query",
"description": "Return operations for transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withLogs",
"required": false,
"in": "query",
"description": "Return logs for transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withScamInfo",
"required": false,
"in": "query",
"description": "Returns scam information",
"schema": {
"type": "boolean"
}
},
{
"name": "withUsername",
"required": false,
"in": "query",
"description": "Integrates username in assets for all addresses present in the transactions",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"collections"
]
}
},
"/nfts/{identifier}": {
"get": {
"operationId": "NftController_getNft",
"summary": "NFT details",
"description": "Returns the details of an Non-Fungible / Semi-Fungible / MetaESDT token for a given identifier",
"parameters": [
{
"name": "identifier",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"nfts"
]
}
},
"/nfts/{identifier}/accounts": {
"get": {
"operationId": "NftController_getNftAccounts",
"summary": "NFT accounts",
"description": "Returns a list of addresses that hold balances for a specific Non-Fungible / Semi-Fungible / MetaESDT token",
"parameters": [
{
"name": "identifier",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"nfts"
]
}
},
"/nfts/{identifier}/accounts/count": {
"get": {
"operationId": "NftController_getNftAccountsCount",
"summary": "NFT accounts count",
"description": "Returns number of addresses that hold balances for a specific Non-Fungible / Semi-Fungible / MetaESDT token",
"parameters": [
{
"name": "identifier",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"nfts"
]
}
},
"/nfts/{identifier}/transactions": {
"get": {
"operationId": "NftController_getNftTransactions",
"summary": "NFT transactions",
"description": "Returns a list of transactions for a NonFungibleESDT or SemiFungibleESDT.",
"parameters": [
{
"name": "identifier",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
},
{
"name": "sender",
"required": false,
"in": "query",
"description": "Address of the transaction sender",
"schema": {
"type": "string"
}
},
{
"name": "receiver",
"required": false,
"in": "query",
"description": "Search by multiple receiver addresses, comma-separated",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "senderShard",
"required": false,
"in": "query",
"description": "Id of the shard the sender address belongs to",
"schema": {
"type": "number"
}
},
{
"name": "receiverShard",
"required": false,
"in": "query",
"description": "Id of the shard the receiver address belongs to",
"schema": {
"type": "number"
}
},
{
"name": "miniBlockHash",
"required": false,
"in": "query",
"description": "Filter by miniblock hash",
"schema": {
"type": "string"
}
},
{
"name": "hashes",
"required": false,
"in": "query",
"description": "Filter by a comma-separated list of transaction hashes",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "status",
"required": false,
"in": "query",
"description": "Status of the transaction (success / pending / invalid / fail)",
"schema": {
"enum": [
"success",
"pending",
"invalid",
"fail"
],
"type": "string"
}
},
{
"name": "function",
"required": false,
"in": "query",
"description": "Filter transactions by function name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "before",
"required": false,
"in": "query",
"description": "Before timestamp",
"schema": {
"type": "number"
}
},
{
"name": "after",
"required": false,
"in": "query",
"description": "After timestamp",
"schema": {
"type": "number"
}
},
{
"name": "order",
"required": false,
"in": "query",
"description": "Sort order (asc/desc)",
"schema": {
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
{
"name": "withScResults",
"required": false,
"in": "query",
"description": "Return scResults for transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withOperations",
"required": false,
"in": "query",
"description": "Return operations for transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withLogs",
"required": false,
"in": "query",
"description": "Return logs for transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withScamInfo",
"required": false,
"in": "query",
"description": "Returns scam information",
"schema": {
"type": "boolean"
}
},
{
"name": "withUsername",
"required": false,
"in": "query",
"description": "Integrates username in assets for all addresses present in the transactions",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"nfts"
]
}
},
"/tokens/{identifier}": {
"get": {
"operationId": "TokenController_getToken",
"summary": "Token",
"description": "Returns token details based on a specific token identifier",
"parameters": [
{
"name": "identifier",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "denominated",
"required": false,
"in": "query",
"description": "Return results denominated",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"tokens"
]
}
},
"/tokens/{identifier}/accounts": {
"get": {
"operationId": "TokenController_getTokenAccounts",
"summary": "Token accounts",
"description": "Returns a list of accounts that hold a specific token",
"parameters": [
{
"name": "identifier",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"tokens"
]
}
},
"/tokens/{identifier}/accounts/count": {
"get": {
"operationId": "TokenController_getTokenAccountsCount",
"summary": "Token accounts count",
"description": "Returns the total number of accounts that hold a specific token",
"parameters": [
{
"name": "identifier",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"tokens"
]
}
},
"/tokens/{identifier}/transactions": {
"get": {
"operationId": "TokenController_getTokenTransactions",
"summary": "Token transactions",
"description": "Returns a list of transactions for a specific token.",
"parameters": [
{
"name": "identifier",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
},
{
"name": "sender",
"required": false,
"in": "query",
"description": "Address of the transaction sender",
"schema": {
"type": "string"
}
},
{
"name": "receiver",
"required": false,
"in": "query",
"description": "Search by multiple receiver addresses, comma-separated",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "senderShard",
"required": false,
"in": "query",
"description": "Id of the shard the sender address belongs to",
"schema": {
"type": "number"
}
},
{
"name": "receiverShard",
"required": false,
"in": "query",
"description": "Id of the shard the receiver address belongs to",
"schema": {
"type": "number"
}
},
{
"name": "miniBlockHash",
"required": false,
"in": "query",
"description": "Filter by miniblock hash",
"schema": {
"type": "string"
}
},
{
"name": "hashes",
"required": false,
"in": "query",
"description": "Filter by a comma-separated list of transaction hashes",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "status",
"required": false,
"in": "query",
"description": "Status of the transaction (success / pending / invalid / fail)",
"schema": {
"enum": [
"success",
"pending",
"invalid",
"fail"
],
"type": "string"
}
},
{
"name": "function",
"required": false,
"in": "query",
"description": "Filter transactions by function name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "before",
"required": false,
"in": "query",
"description": "Before timestamp",
"schema": {
"type": "number"
}
},
{
"name": "after",
"required": false,
"in": "query",
"description": "After timestamp",
"schema": {
"type": "number"
}
},
{
"name": "order",
"required": false,
"in": "query",
"description": "Sort order (asc/desc)",
"schema": {
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
{
"name": "fields",
"required": true,
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "withScResults",
"required": false,
"in": "query",
"description": "Return scResults for transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withOperations",
"required": false,
"in": "query",
"description": "Return operations for transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withLogs",
"required": false,
"in": "query",
"description": "Return logs for transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withScamInfo",
"required": false,
"in": "query",
"description": "Returns scam information",
"schema": {
"type": "boolean"
}
},
{
"name": "withUsername",
"required": false,
"in": "query",
"description": "Integrates username in assets for all addresses present in the transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withBlockInfo",
"required": false,
"in": "query",
"description": "Returns sender / receiver block details",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"tokens"
]
}
},
"/transactions/{txHash}": {
"get": {
"operationId": "TransactionController_getTransaction",
"summary": "Transaction details",
"description": "Return transaction details for a given transaction hash",
"parameters": [
{
"name": "txHash",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "fields",
"required": false,
"in": "query",
"description": "List of fields to filter by",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"transactions"
]
}
},
"/usernames/{username}": {
"get": {
"operationId": "UsernameController_getUsernameDetails",
"summary": "Account details by username",
"description": "Returns account details for a given username. Performs a redirect on the proper account address",
"parameters": [
{
"name": "username",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "withGuardianInfo",
"required": true,
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"usernames"
]
}
}
},
"info": {
"title": "Multiversx API",
"description": "The API is built to allow you to create apps or integrations quickly and easily.\n\nThis API is organized around REST principles, so if you've interacted with RESTful APIs before, many of the concepts will look familiar.\n\n## Request\n* Requests with a message body use JSON. Successful requests will return a `2xx` HTTP status.\n\n## Response\n\n* JSON will be returned for all responses, including errors.\n\n## Parameters\n\n* Some endpoints accept optional parameters which can be passed as query string params. \n* All parameters are documented along each endpoint.\n\n## Complexity\n\n* In order to better optimize the available resources, a complexity evaluation is performed before the execution of every request.\n\n* The maximum complexity available is currently hardcoded at `10000`\n\n* When listing entries, every element in the list adds `1` to the complexity, thus making it possible to retrieve a maximum of `10000` elements in list endpoints.\n\n* If some extra info is requested, such as `withScResults` in the `/transactions` endpoint, the complexity calculation for the list is overridden with the complexity calculation of the requested field. In this situation, `withScResults` will multiply the number of items with `200`, thus limiting the maximum requested size to `50`\n\n* Some fields use the same amount of resources whether one or more of them are requested. In this situation, the fields will be grouped together, regardless whether one or more of the same group are requested. The endpoints `/transactions?size=50&withOperations=true` will produce the same complexity as `/transactions?size=50&withOperations=true&withLogs=true&withScResults=true` since they all belong to the group `details`\n\n## Fields\n\n* In order to fetch only specific fields from the response, the `fields` parameter can be used:\n * `/accounts?fields=address,balance for arrays`\n * `/economics?fields=price,marketCap for object`\n\n## Extract\n* In order to extract a scalar value from an object response, the `extract` parameter can be used:\n * `/economics?extract=price`\n\n## Cleanup\n* If the value of an attribute is `undefined`, `\"\"` (empty string), `null`, `[ ]` (empty array) the attribute will be omitted.\n\n## Pagination\n\n* Requests that return multiple items will be paginated to 25 items by default. \n* For a different number of items or for the next pages `?from=` and `size=` can be used.\n",
"version": "1.0.0",
"contact": {}
},
"tags": [],
"servers": [
{
"url": "https://api.multiversx.com"
}
],
"externalDocs": {
"description": "Find out more about Multiversx API",
"url": "https://docs.multiversx.com/sdk-and-tools/rest-api/rest-api/"
}
}Multiversx API
The API is built to allow you to create apps or integrations quickly and easily. This API is organized around REST principles, so if you've interacted with RESTful APIs before, many of the concepts will look familiar. ## Request * Requests with a message body use JSON. Successful requests will return a `2xx` HTTP status. ## Response * JSON will be returned for all responses, including errors. ## Parameters * Some endpoints accept optional parameters which can be passed as query string params. * All parameters are documented along each endpoint. ## Complexity * In order to better optimize the available resources, a complexity evaluation is performed before the execution of every request. * The maximum complexity available is currently hardcoded at `10000` * When listing entries, every element in the list adds `1` to the complexity, thus making it possible to retrieve a maximum of `10000` elements in list endpoints. * If some extra info is requested, such as `withScResults` in the `/transactions` endpoint, the complexity calculation for the list is overridden with the complexity calculation of the requested field. In this situation, `withScResults` will multiply the number of items with `200`, thus limiting the maximum requested size to `50` * Some fields use the same amount of resources whether one or more of them are requested. In this situation, the fields will be grouped together, regardless whether one or more of the same group are requested. The endpoints `/transactions?size=50&withOperations=true` will produce the same complexity as `/transactions?size=50&withOperations=true&withLogs=true&withScResults=true` since they all belong to the group `details` ## Fields * In order to fetch only specific fields from the response, the `fields` parameter can be used: * `/accounts?fields=address,balance for arrays` * `/economics?fields=price,marketCap for object` ## Extract * In order to extract a scalar value from an object response, the `extract` parameter can be used: * `/economics?extract=price` ## Cleanup * If the value of an attribute is `undefined`, `""` (empty string), `null`, `[ ]` (empty array) the attribute will be omitted. ## Pagination * Requests that return multiple items will be paginated to 25 items by default. * For a different number of items or for the next pages `?from=` and `size=` can be used.
GET /accountsAccounts detailsReturns all accounts available on blockchain. By default it returns 25 accounts
GET /accounts/countTotal number of accountsReturns total number of accounts available on blockchain
GET /accounts/{address}Account detailsReturns account details for a given address
GET /accounts/{address}/tokensAccount tokensReturns a list of all available fungible tokens for a given address, together with their balance
GET /accounts/{address}/tokens/countAccount token countReturns the total number of tokens for a given address
GET /accounts/{address}/tokens/{token}Account token detailsReturns details about a specific fungible token from a given address
GET /accounts/{address}/collectionsAccount collectionsReturns NFT/SFT/MetaESDT collections where the account owns one or more NFTs
GET /accounts/{address}/collections/{collection}Account collection detailsReturns details about a specific NFT/SFT/MetaESDT collection from a given address
GET /accounts/{address}/nftsAccount NFTsReturns a list of all available NFTs/SFTs/MetaESDTs owned by the provided address
GET /accounts/{address}/nfts/countAccount NFT/SFT tokens countReturns the total number of NFT/SFT tokens from a given address, as well as the total number of a certain type of ESDT
GET /accounts/{address}/nfts/{nft}Account NFT/SFT token detailsReturns details about a specific fungible token for a given address
GET /accounts/{address}/transactionsAccount transaction listReturns details of all transactions where the account is sender or receiver
GET /accounts/{address}/contractsAccount smart contracts detailsReturns smart contracts details for a given account
GET /collections/{collection}/nftsCollection NFTsReturns non-fungible/semi-fungible/meta-esdt tokens that belong to a collection
GET /collections/{collection}/nfts/countCollection NFT countReturns non-fungible/semi-fungible/meta-esdt token count that belong to a collection
GET /collections/{identifier}/accountsCollection accountsReturns a list of addresses and balances for a specific collection
GET /collections/{collection}/transactionsCollection transactionsReturns a list of transactions for a specific collection.
GET /nfts/{identifier}NFT detailsReturns the details of an Non-Fungible / Semi-Fungible / MetaESDT token for a given identifier
GET /nfts/{identifier}/accountsNFT accountsReturns a list of addresses that hold balances for a specific Non-Fungible / Semi-Fungible / MetaESDT token
GET /nfts/{identifier}/accounts/countNFT accounts countReturns number of addresses that hold balances for a specific Non-Fungible / Semi-Fungible / MetaESDT token
GET /nfts/{identifier}/transactionsNFT transactionsReturns a list of transactions for a NonFungibleESDT or SemiFungibleESDT.
GET /tokens/{identifier}TokenReturns token details based on a specific token identifier
GET /tokens/{identifier}/accountsToken accountsReturns a list of accounts that hold a specific token
GET /tokens/{identifier}/accounts/countToken accounts countReturns the total number of accounts that hold a specific token
GET /tokens/{identifier}/transactionsToken transactionsReturns a list of transactions for a specific token.
GET /transactions/{txHash}Transaction detailsReturn transaction details for a given transaction hash
GET /usernames/{username}Account details by usernameReturns account details for a given username. Performs a redirect on the proper account address
Esquema original API
{
"openapi": "3.0.0",
"paths": {
"/accounts": {
"get": {
"operationId": "AccountController_getAccounts",
"summary": "Accounts details",
"description": "Returns all accounts available on blockchain. By default it returns 25 accounts",
"parameters": [
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
},
{
"name": "ownerAddress",
"required": false,
"in": "query",
"description": "Search by owner address",
"schema": {
"type": "string"
}
},
{
"name": "sort",
"required": false,
"in": "query",
"description": "Sort criteria (balance / timestamp)",
"schema": {
"enum": [
"balance",
"timestamp"
],
"type": "string"
}
},
{
"name": "order",
"required": false,
"in": "query",
"description": "Sort order (asc/desc)",
"schema": {
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
{
"name": "isSmartContract",
"required": false,
"in": "query",
"description": "Return a list of smart contracts",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/count": {
"get": {
"operationId": "AccountController_getAccountsCount",
"summary": "Total number of accounts",
"description": "Returns total number of accounts available on blockchain",
"parameters": [
{
"name": "ownerAddress",
"required": false,
"in": "query",
"description": "Search by owner address",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}": {
"get": {
"operationId": "AccountController_getAccountDetails",
"summary": "Account details",
"description": "Returns account details for a given address",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "withGuardianInfo",
"required": false,
"in": "query",
"description": "Returns guardian data for a given address",
"schema": {
"type": "boolean"
}
},
{
"name": "fields",
"required": false,
"in": "query",
"description": "List of fields to filter by",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}/tokens": {
"get": {
"operationId": "AccountController_getAccountTokens",
"summary": "Account tokens",
"description": "Returns a list of all available fungible tokens for a given address, together with their balance",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
},
{
"name": "type",
"required": false,
"in": "query",
"description": "Token type",
"schema": {
"enum": [
"FungibleESDT",
"MetaESDT"
],
"type": "string"
}
},
{
"name": "search",
"required": false,
"in": "query",
"description": "Search by collection identifier",
"schema": {
"type": "string"
}
},
{
"name": "name",
"required": false,
"in": "query",
"description": "Search by token name",
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"required": false,
"in": "query",
"description": "Search by token identifier",
"schema": {
"type": "string"
}
},
{
"name": "identifiers",
"required": false,
"in": "query",
"description": "A comma-separated list of identifiers to filter by",
"schema": {
"type": "string"
}
},
{
"name": "includeMetaESDT",
"required": false,
"in": "query",
"description": "Include MetaESDTs in response",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}/tokens/count": {
"get": {
"operationId": "AccountController_getTokenCount",
"summary": "Account token count",
"description": "Returns the total number of tokens for a given address",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "type",
"required": false,
"in": "query",
"description": "Token type",
"schema": {
"enum": [
"FungibleESDT",
"MetaESDT"
],
"type": "string"
}
},
{
"name": "search",
"required": false,
"in": "query",
"description": "Search by collection identifier",
"schema": {
"type": "string"
}
},
{
"name": "name",
"required": false,
"in": "query",
"description": "Search by token name",
"schema": {
"type": "string"
}
},
{
"name": "identifier",
"required": false,
"in": "query",
"description": "Search by token identifier",
"schema": {
"type": "string"
}
},
{
"name": "identifiers",
"required": false,
"in": "query",
"description": "A comma-separated list of identifiers to filter by",
"schema": {
"type": "string"
}
},
{
"name": "includeMetaESDT",
"required": false,
"in": "query",
"description": "Include MetaESDTs in response",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}/tokens/{token}": {
"get": {
"operationId": "AccountController_getAccountToken",
"summary": "Account token details",
"description": "Returns details about a specific fungible token from a given address",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "token",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}/collections": {
"get": {
"operationId": "AccountController_getAccountNftCollections",
"summary": "Account collections",
"description": "Returns NFT/SFT/MetaESDT collections where the account owns one or more NFTs",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
},
{
"name": "search",
"required": false,
"in": "query",
"description": "Search by collection identifier",
"schema": {
"type": "string"
}
},
{
"name": "type",
"required": false,
"in": "query",
"description": "Filter by type (NonFungibleESDT/SemiFungibleESDT/MetaESDT)",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "excludeMetaESDT",
"required": false,
"in": "query",
"description": "Exclude collections of type \"MetaESDT\" in the response",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}/collections/{collection}": {
"get": {
"operationId": "AccountController_getAccountNftCollection",
"summary": "Account collection details",
"description": "Returns details about a specific NFT/SFT/MetaESDT collection from a given address",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "collection",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}/nfts": {
"get": {
"operationId": "AccountController_getAccountNfts",
"summary": "Account NFTs",
"description": "Returns a list of all available NFTs/SFTs/MetaESDTs owned by the provided address",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
},
{
"name": "search",
"required": false,
"in": "query",
"description": "Search by collection identifier",
"schema": {
"type": "string"
}
},
{
"name": "identifiers",
"required": false,
"in": "query",
"description": "Filter by identifiers, comma-separated",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "type",
"required": false,
"in": "query",
"description": "Filter by type (NonFungibleESDT/SemiFungibleESDT/MetaESDT)",
"schema": {
"type": "string"
}
},
{
"name": "collection",
"required": false,
"in": "query",
"description": "Get all tokens by token collection. Deprecated, replaced by collections parameter",
"deprecated": true,
"schema": {
"type": "string"
}
},
{
"name": "collections",
"required": false,
"in": "query",
"description": "Get all tokens by token collections, comma-separated",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "name",
"required": false,
"in": "query",
"description": "Get all nfts by name",
"schema": {
"type": "string"
}
},
{
"name": "tags",
"required": false,
"in": "query",
"description": "Filter by one or more comma-separated tags",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "creator",
"required": false,
"in": "query",
"description": "Return all NFTs associated with a given creator",
"schema": {
"type": "string"
}
},
{
"name": "hasUris",
"required": false,
"in": "query",
"description": "Return all NFTs that have one or more uris",
"schema": {
"type": "boolean"
}
},
{
"name": "includeFlagged",
"required": false,
"in": "query",
"description": "Include NFTs that are flagged or not",
"schema": {
"type": "boolean"
}
},
{
"name": "withSupply",
"required": false,
"in": "query",
"description": "Return supply where type = SemiFungibleESDT",
"schema": {
"type": "boolean"
}
},
{
"name": "withScamInfo",
"required": false,
"in": "query",
"description": "Include scam info in the response",
"schema": {
"type": "boolean"
}
},
{
"name": "computeScamInfo",
"required": false,
"in": "query",
"description": "Compute scam info in the response",
"schema": {
"type": "boolean"
}
},
{
"name": "source",
"required": false,
"in": "query",
"description": "Data source of request",
"schema": {
"type": "string"
}
},
{
"name": "excludeMetaESDT",
"required": false,
"in": "query",
"description": "Exclude NFTs of type \"MetaESDT\" in the response",
"schema": {
"type": "boolean"
}
},
{
"name": "fields",
"required": false,
"in": "query",
"description": "List of fields to filter by",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}/nfts/count": {
"get": {
"operationId": "AccountController_getNftCount",
"summary": "Account NFT/SFT tokens count",
"description": "Returns the total number of NFT/SFT tokens from a given address, as well as the total number of a certain type of ESDT ",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "identifiers",
"required": false,
"in": "query",
"description": "Filter by identifiers, comma-separated",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "search",
"required": false,
"in": "query",
"description": "Search by collection identifier",
"schema": {
"type": "string"
}
},
{
"name": "type",
"required": false,
"in": "query",
"description": "Filter by type (NonFungibleESDT/SemiFungibleESDT/MetaESDT)",
"schema": {
"type": "string"
}
},
{
"name": "collection",
"required": false,
"in": "query",
"description": "Get all tokens by token collection",
"schema": {
"type": "string"
}
},
{
"name": "collections",
"required": false,
"in": "query",
"description": "Get all tokens by token collections, comma-separated",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "name",
"required": false,
"in": "query",
"description": "Get all nfts by name",
"schema": {
"type": "string"
}
},
{
"name": "tags",
"required": false,
"in": "query",
"description": "Filter by one or more comma-separated tags",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "creator",
"required": false,
"in": "query",
"description": "Return all NFTs associated with a given creator",
"schema": {
"type": "string"
}
},
{
"name": "hasUris",
"required": false,
"in": "query",
"description": "Return all NFTs that have one or more uris",
"schema": {
"type": "boolean"
}
},
{
"name": "includeFlagged",
"required": false,
"in": "query",
"description": "Include NFTs that are flagged or not",
"schema": {
"type": "boolean"
}
},
{
"name": "excludeMetaESDT",
"required": false,
"in": "query",
"description": "Exclude NFTs of type \"MetaESDT\" in the response",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}/nfts/{nft}": {
"get": {
"operationId": "AccountController_getAccountNft",
"summary": "Account NFT/SFT token details",
"description": "Returns details about a specific fungible token for a given address",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "nft",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "fields",
"required": false,
"in": "query",
"description": "List of fields to filter by",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "extract",
"required": false,
"in": "query",
"description": "Extract a specific field",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}/transactions": {
"get": {
"operationId": "AccountController_getAccountTransactions",
"summary": "Account transaction list",
"description": "Returns details of all transactions where the account is sender or receiver",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
},
{
"name": "sender",
"required": false,
"in": "query",
"description": "Address of the transaction sender",
"schema": {
"type": "string"
}
},
{
"name": "receiver",
"required": false,
"in": "query",
"description": "Search by multiple receiver addresses, comma-separated",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "token",
"required": false,
"in": "query",
"description": "Identifier of the token",
"schema": {
"type": "string"
}
},
{
"name": "senderShard",
"required": false,
"in": "query",
"description": "Id of the shard the sender address belongs to",
"schema": {
"type": "number"
}
},
{
"name": "receiverShard",
"required": false,
"in": "query",
"description": "Id of the shard the receiver address belongs to",
"schema": {
"type": "number"
}
},
{
"name": "miniBlockHash",
"required": false,
"in": "query",
"description": "Filter by miniblock hash",
"schema": {
"type": "string"
}
},
{
"name": "hashes",
"required": false,
"in": "query",
"description": "Filter by a comma-separated list of transaction hashes",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "status",
"required": false,
"in": "query",
"description": "Status of the transaction (success / pending / invalid / fail)",
"schema": {
"enum": [
"success",
"pending",
"invalid",
"fail"
],
"type": "string"
}
},
{
"name": "function",
"required": false,
"in": "query",
"description": "Filter transactions by function name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "before",
"required": false,
"in": "query",
"description": "Before timestamp",
"schema": {
"type": "number"
}
},
{
"name": "after",
"required": false,
"in": "query",
"description": "After timestamp",
"schema": {
"type": "number"
}
},
{
"name": "order",
"required": false,
"in": "query",
"description": "Sort order (asc/desc)",
"schema": {
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
{
"name": "fields",
"required": false,
"in": "query",
"description": "List of fields to filter by",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "withScResults",
"required": false,
"in": "query",
"description": "Return scResults for transactions. When \"withScresults\" parameter is applied, complexity estimation is 200",
"schema": {
"type": "boolean"
}
},
{
"name": "withOperations",
"required": false,
"in": "query",
"description": "Return operations for transactions. When \"withOperations\" parameter is applied, complexity estimation is 200",
"schema": {
"type": "boolean"
}
},
{
"name": "withLogs",
"required": false,
"in": "query",
"description": "Return logs for transactions. When \"withLogs\" parameter is applied, complexity estimation is 200",
"schema": {
"type": "boolean"
}
},
{
"name": "withScamInfo",
"required": false,
"in": "query",
"description": "Returns scam information",
"schema": {
"type": "boolean"
}
},
{
"name": "withUsername",
"required": false,
"in": "query",
"description": "Integrates username in assets for all addresses present in the transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withBlockInfo",
"required": false,
"in": "query",
"description": "Returns sender / receiver block details",
"schema": {
"type": "boolean"
}
},
{
"name": "senderOrReceiver",
"required": false,
"in": "query",
"description": "One address that current address interacted with",
"schema": {
"type": "string"
}
},
{
"name": "isRelayed",
"required": false,
"in": "query",
"description": "Returns isRelayed transactions details",
"schema": {
"type": "boolean"
}
},
{
"name": "computeScamInfo",
"required": false,
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/accounts/{address}/contracts": {
"get": {
"operationId": "AccountController_getAccountContracts",
"summary": "Account smart contracts details",
"description": "Returns smart contracts details for a given account",
"parameters": [
{
"name": "address",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"accounts"
]
}
},
"/collections/{collection}/nfts": {
"get": {
"operationId": "CollectionController_getNfts",
"summary": "Collection NFTs",
"description": "Returns non-fungible/semi-fungible/meta-esdt tokens that belong to a collection",
"parameters": [
{
"name": "collection",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
},
{
"name": "search",
"required": false,
"in": "query",
"description": "Search by collection identifier",
"schema": {
"type": "string"
}
},
{
"name": "identifiers",
"required": false,
"in": "query",
"description": "Search by token identifiers, comma-separated",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "name",
"required": false,
"in": "query",
"description": "Get all nfts by name",
"schema": {
"type": "string"
}
},
{
"name": "tags",
"required": false,
"in": "query",
"description": "Filter by one or more comma-separated tags",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "creator",
"required": false,
"in": "query",
"description": "Return all NFTs associated with a given creator",
"schema": {
"type": "string"
}
},
{
"name": "isWhitelistedStorage",
"required": false,
"in": "query",
"description": "Return all NFTs that are whitelisted in storage",
"schema": {
"type": "boolean"
}
},
{
"name": "hasUris",
"required": false,
"in": "query",
"description": "Return all NFTs that have one or more uris",
"schema": {
"type": "boolean"
}
},
{
"name": "isNsfw",
"required": false,
"in": "query",
"description": "Filter by NSFW status",
"schema": {
"type": "boolean"
}
},
{
"name": "nonceBefore",
"required": false,
"in": "query",
"description": "Return all NFTs with given nonce before the given number",
"schema": {
"type": "number"
}
},
{
"name": "nonceAfter",
"required": false,
"in": "query",
"description": "Return all NFTs with given nonce after the given number",
"schema": {
"type": "number"
}
},
{
"name": "withOwner",
"required": false,
"in": "query",
"description": "Return owner where type = NonFungibleESDT",
"schema": {
"type": "boolean"
}
},
{
"name": "withSupply",
"required": false,
"in": "query",
"description": "Return supply where type = SemiFungibleESDT",
"schema": {
"type": "boolean"
}
},
{
"name": "withScamInfo",
"required": false,
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "computeScamInfo",
"required": false,
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "sort",
"required": false,
"in": "query",
"description": "Sorting criteria",
"schema": {
"enum": [
"timestamp",
"rank",
"nonce"
],
"type": "string"
}
},
{
"name": "order",
"required": false,
"in": "query",
"description": "Sorting order (asc / desc)",
"schema": {
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
{
"name": "traits",
"required": false,
"in": "query",
"description": "Filter NFTs by traits. Key-value format (<key1>:<value1>;<key2>:<value2>)",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"collections"
]
}
},
"/collections/{collection}/nfts/count": {
"get": {
"operationId": "CollectionController_getNftCount",
"summary": "Collection NFT count",
"description": "Returns non-fungible/semi-fungible/meta-esdt token count that belong to a collection",
"parameters": [
{
"name": "collection",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "search",
"required": false,
"in": "query",
"description": "Search by collection identifier",
"schema": {
"type": "string"
}
},
{
"name": "identifiers",
"required": false,
"in": "query",
"description": "Search by token identifiers, comma-separated",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "name",
"required": false,
"in": "query",
"description": "Get all nfts by name",
"schema": {
"type": "string"
}
},
{
"name": "tags",
"required": false,
"in": "query",
"description": "Filter by one or more comma-separated tags",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "creator",
"required": false,
"in": "query",
"description": "Return all NFTs associated with a given creator",
"schema": {
"type": "string"
}
},
{
"name": "isWhitelistedStorage",
"required": false,
"in": "query",
"description": "Return all NFTs that are whitelisted in storage",
"schema": {
"type": "boolean"
}
},
{
"name": "hasUris",
"required": false,
"in": "query",
"description": "Return all NFTs that have one or more uris",
"schema": {
"type": "boolean"
}
},
{
"name": "nonceBefore",
"required": false,
"in": "query",
"description": "Return all NFTs with given nonce before the given number",
"schema": {
"type": "number"
}
},
{
"name": "nonceAfter",
"required": false,
"in": "query",
"description": "Return all NFTs with given nonce after the given number",
"schema": {
"type": "number"
}
},
{
"name": "traits",
"required": false,
"in": "query",
"description": "Filter NFTs by traits. Key-value format (<key1>:<value1>;<key2>:<value2>)",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"collections"
]
}
},
"/collections/{identifier}/accounts": {
"get": {
"operationId": "CollectionController_getNftAccounts",
"summary": "Collection accounts",
"description": "Returns a list of addresses and balances for a specific collection",
"parameters": [
{
"name": "identifier",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"collections"
]
}
},
"/collections/{collection}/transactions": {
"get": {
"operationId": "CollectionController_getCollectionTransactions",
"summary": "Collection transactions",
"description": "Returns a list of transactions for a specific collection.",
"parameters": [
{
"name": "collection",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
},
{
"name": "sender",
"required": false,
"in": "query",
"description": "Address of the transaction sender",
"schema": {
"type": "string"
}
},
{
"name": "receiver",
"required": false,
"in": "query",
"description": "Search by multiple receiver addresses, comma-separated",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "senderShard",
"required": false,
"in": "query",
"description": "Id of the shard the sender address belongs to",
"schema": {
"type": "number"
}
},
{
"name": "receiverShard",
"required": false,
"in": "query",
"description": "Id of the shard the receiver address belongs to",
"schema": {
"type": "number"
}
},
{
"name": "miniBlockHash",
"required": false,
"in": "query",
"description": "Filter by miniblock hash",
"schema": {
"type": "string"
}
},
{
"name": "hashes",
"required": false,
"in": "query",
"description": "Filter by a comma-separated list of transaction hashes",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "status",
"required": false,
"in": "query",
"description": "Status of the transaction (success / pending / invalid / fail)",
"schema": {
"enum": [
"success",
"pending",
"invalid",
"fail"
],
"type": "string"
}
},
{
"name": "function",
"required": false,
"in": "query",
"description": "Filter transactions by function name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "before",
"required": false,
"in": "query",
"description": "Before timestamp",
"schema": {
"type": "number"
}
},
{
"name": "after",
"required": false,
"in": "query",
"description": "After timestamp",
"schema": {
"type": "number"
}
},
{
"name": "order",
"required": false,
"in": "query",
"description": "Sort order (asc/desc)",
"schema": {
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
{
"name": "withScResults",
"required": false,
"in": "query",
"description": "Return scResults for transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withOperations",
"required": false,
"in": "query",
"description": "Return operations for transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withLogs",
"required": false,
"in": "query",
"description": "Return logs for transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withScamInfo",
"required": false,
"in": "query",
"description": "Returns scam information",
"schema": {
"type": "boolean"
}
},
{
"name": "withUsername",
"required": false,
"in": "query",
"description": "Integrates username in assets for all addresses present in the transactions",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"collections"
]
}
},
"/nfts/{identifier}": {
"get": {
"operationId": "NftController_getNft",
"summary": "NFT details",
"description": "Returns the details of an Non-Fungible / Semi-Fungible / MetaESDT token for a given identifier",
"parameters": [
{
"name": "identifier",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"nfts"
]
}
},
"/nfts/{identifier}/accounts": {
"get": {
"operationId": "NftController_getNftAccounts",
"summary": "NFT accounts",
"description": "Returns a list of addresses that hold balances for a specific Non-Fungible / Semi-Fungible / MetaESDT token",
"parameters": [
{
"name": "identifier",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"nfts"
]
}
},
"/nfts/{identifier}/accounts/count": {
"get": {
"operationId": "NftController_getNftAccountsCount",
"summary": "NFT accounts count",
"description": "Returns number of addresses that hold balances for a specific Non-Fungible / Semi-Fungible / MetaESDT token",
"parameters": [
{
"name": "identifier",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"nfts"
]
}
},
"/nfts/{identifier}/transactions": {
"get": {
"operationId": "NftController_getNftTransactions",
"summary": "NFT transactions",
"description": "Returns a list of transactions for a NonFungibleESDT or SemiFungibleESDT.",
"parameters": [
{
"name": "identifier",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
},
{
"name": "sender",
"required": false,
"in": "query",
"description": "Address of the transaction sender",
"schema": {
"type": "string"
}
},
{
"name": "receiver",
"required": false,
"in": "query",
"description": "Search by multiple receiver addresses, comma-separated",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "senderShard",
"required": false,
"in": "query",
"description": "Id of the shard the sender address belongs to",
"schema": {
"type": "number"
}
},
{
"name": "receiverShard",
"required": false,
"in": "query",
"description": "Id of the shard the receiver address belongs to",
"schema": {
"type": "number"
}
},
{
"name": "miniBlockHash",
"required": false,
"in": "query",
"description": "Filter by miniblock hash",
"schema": {
"type": "string"
}
},
{
"name": "hashes",
"required": false,
"in": "query",
"description": "Filter by a comma-separated list of transaction hashes",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "status",
"required": false,
"in": "query",
"description": "Status of the transaction (success / pending / invalid / fail)",
"schema": {
"enum": [
"success",
"pending",
"invalid",
"fail"
],
"type": "string"
}
},
{
"name": "function",
"required": false,
"in": "query",
"description": "Filter transactions by function name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "before",
"required": false,
"in": "query",
"description": "Before timestamp",
"schema": {
"type": "number"
}
},
{
"name": "after",
"required": false,
"in": "query",
"description": "After timestamp",
"schema": {
"type": "number"
}
},
{
"name": "order",
"required": false,
"in": "query",
"description": "Sort order (asc/desc)",
"schema": {
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
{
"name": "withScResults",
"required": false,
"in": "query",
"description": "Return scResults for transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withOperations",
"required": false,
"in": "query",
"description": "Return operations for transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withLogs",
"required": false,
"in": "query",
"description": "Return logs for transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withScamInfo",
"required": false,
"in": "query",
"description": "Returns scam information",
"schema": {
"type": "boolean"
}
},
{
"name": "withUsername",
"required": false,
"in": "query",
"description": "Integrates username in assets for all addresses present in the transactions",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"nfts"
]
}
},
"/tokens/{identifier}": {
"get": {
"operationId": "TokenController_getToken",
"summary": "Token",
"description": "Returns token details based on a specific token identifier",
"parameters": [
{
"name": "identifier",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "denominated",
"required": false,
"in": "query",
"description": "Return results denominated",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"tokens"
]
}
},
"/tokens/{identifier}/accounts": {
"get": {
"operationId": "TokenController_getTokenAccounts",
"summary": "Token accounts",
"description": "Returns a list of accounts that hold a specific token",
"parameters": [
{
"name": "identifier",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"tokens"
]
}
},
"/tokens/{identifier}/accounts/count": {
"get": {
"operationId": "TokenController_getTokenAccountsCount",
"summary": "Token accounts count",
"description": "Returns the total number of accounts that hold a specific token",
"parameters": [
{
"name": "identifier",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"tokens"
]
}
},
"/tokens/{identifier}/transactions": {
"get": {
"operationId": "TokenController_getTokenTransactions",
"summary": "Token transactions",
"description": "Returns a list of transactions for a specific token.",
"parameters": [
{
"name": "identifier",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "from",
"required": false,
"in": "query",
"description": "Number of items to skip for the result set",
"schema": {
"type": "number"
}
},
{
"name": "size",
"required": false,
"in": "query",
"description": "Number of items to retrieve",
"schema": {
"type": "number"
}
},
{
"name": "sender",
"required": false,
"in": "query",
"description": "Address of the transaction sender",
"schema": {
"type": "string"
}
},
{
"name": "receiver",
"required": false,
"in": "query",
"description": "Search by multiple receiver addresses, comma-separated",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "senderShard",
"required": false,
"in": "query",
"description": "Id of the shard the sender address belongs to",
"schema": {
"type": "number"
}
},
{
"name": "receiverShard",
"required": false,
"in": "query",
"description": "Id of the shard the receiver address belongs to",
"schema": {
"type": "number"
}
},
{
"name": "miniBlockHash",
"required": false,
"in": "query",
"description": "Filter by miniblock hash",
"schema": {
"type": "string"
}
},
{
"name": "hashes",
"required": false,
"in": "query",
"description": "Filter by a comma-separated list of transaction hashes",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "status",
"required": false,
"in": "query",
"description": "Status of the transaction (success / pending / invalid / fail)",
"schema": {
"enum": [
"success",
"pending",
"invalid",
"fail"
],
"type": "string"
}
},
{
"name": "function",
"required": false,
"in": "query",
"description": "Filter transactions by function name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "before",
"required": false,
"in": "query",
"description": "Before timestamp",
"schema": {
"type": "number"
}
},
{
"name": "after",
"required": false,
"in": "query",
"description": "After timestamp",
"schema": {
"type": "number"
}
},
{
"name": "order",
"required": false,
"in": "query",
"description": "Sort order (asc/desc)",
"schema": {
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
{
"name": "fields",
"required": true,
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "withScResults",
"required": false,
"in": "query",
"description": "Return scResults for transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withOperations",
"required": false,
"in": "query",
"description": "Return operations for transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withLogs",
"required": false,
"in": "query",
"description": "Return logs for transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withScamInfo",
"required": false,
"in": "query",
"description": "Returns scam information",
"schema": {
"type": "boolean"
}
},
{
"name": "withUsername",
"required": false,
"in": "query",
"description": "Integrates username in assets for all addresses present in the transactions",
"schema": {
"type": "boolean"
}
},
{
"name": "withBlockInfo",
"required": false,
"in": "query",
"description": "Returns sender / receiver block details",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"tokens"
]
}
},
"/transactions/{txHash}": {
"get": {
"operationId": "TransactionController_getTransaction",
"summary": "Transaction details",
"description": "Return transaction details for a given transaction hash",
"parameters": [
{
"name": "txHash",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "fields",
"required": false,
"in": "query",
"description": "List of fields to filter by",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"transactions"
]
}
},
"/usernames/{username}": {
"get": {
"operationId": "UsernameController_getUsernameDetails",
"summary": "Account details by username",
"description": "Returns account details for a given username. Performs a redirect on the proper account address",
"parameters": [
{
"name": "username",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "withGuardianInfo",
"required": true,
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"tags": [
"usernames"
]
}
}
},
"info": {
"title": "Multiversx API",
"description": "The API is built to allow you to create apps or integrations quickly and easily.\n\nThis API is organized around REST principles, so if you've interacted with RESTful APIs before, many of the concepts will look familiar.\n\n## Request\n* Requests with a message body use JSON. Successful requests will return a `2xx` HTTP status.\n\n## Response\n\n* JSON will be returned for all responses, including errors.\n\n## Parameters\n\n* Some endpoints accept optional parameters which can be passed as query string params. \n* All parameters are documented along each endpoint.\n\n## Complexity\n\n* In order to better optimize the available resources, a complexity evaluation is performed before the execution of every request.\n\n* The maximum complexity available is currently hardcoded at `10000`\n\n* When listing entries, every element in the list adds `1` to the complexity, thus making it possible to retrieve a maximum of `10000` elements in list endpoints.\n\n* If some extra info is requested, such as `withScResults` in the `/transactions` endpoint, the complexity calculation for the list is overridden with the complexity calculation of the requested field. In this situation, `withScResults` will multiply the number of items with `200`, thus limiting the maximum requested size to `50`\n\n* Some fields use the same amount of resources whether one or more of them are requested. In this situation, the fields will be grouped together, regardless whether one or more of the same group are requested. The endpoints `/transactions?size=50&withOperations=true` will produce the same complexity as `/transactions?size=50&withOperations=true&withLogs=true&withScResults=true` since they all belong to the group `details`\n\n## Fields\n\n* In order to fetch only specific fields from the response, the `fields` parameter can be used:\n * `/accounts?fields=address,balance for arrays`\n * `/economics?fields=price,marketCap for object`\n\n## Extract\n* In order to extract a scalar value from an object response, the `extract` parameter can be used:\n * `/economics?extract=price`\n\n## Cleanup\n* If the value of an attribute is `undefined`, `\"\"` (empty string), `null`, `[ ]` (empty array) the attribute will be omitted.\n\n## Pagination\n\n* Requests that return multiple items will be paginated to 25 items by default. \n* For a different number of items or for the next pages `?from=` and `size=` can be used.\n",
"version": "1.0.0",
"contact": {}
},
"tags": [],
"servers": [
{
"url": "https://devnet-api.multiversx.com"
}
],
"externalDocs": {
"description": "Find out more about Multiversx API",
"url": "https://docs.multiversx.com/sdk-and-tools/rest-api/rest-api/"
}
}