{ "opencollection": "1.0.0", "info": { "name": "Mirror Node REST accounts API", "version": "0.156.0" }, "items": [ { "info": { "name": "accounts", "type": "folder" }, "items": [ { "info": { "name": "List account entities on network", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/accounts", "params": [ { "name": "account.balance", "value": "", "type": "query", "description": "The optional balance value to compare against" }, { "name": "account.id", "value": "", "type": "query", "description": "The ID of the account to return information for" }, { "name": "account.publickey", "value": "3c3d546321ff6f63d701d2ec5c277095874e19f4a235bee1e6bb19258bf362be", "type": "query", "description": "The account's public key to compare against" }, { "name": "balance", "value": "true", "type": "query", "description": "Whether to include balance information or not. If included, token balances are limited to at most 50 per account as outlined in HIP-367. If multiple values are provided the last value will be the only value used." }, { "name": "limit", "value": "2", "type": "query", "description": "The maximum number of items to return" }, { "name": "order", "value": "desc", "type": "query", "description": "The order in which items are listed" } ] }, "docs": "Returns a list of all account entity items on the network." }, { "info": { "name": "Get account by alias, id, or evm address", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/accounts/:idOrAliasOrEvmAddress", "params": [ { "name": "idOrAliasOrEvmAddress", "value": "", "type": "path", "description": "Account alias or account id or evm address" }, { "name": "limit", "value": "2", "type": "query", "description": "The maximum number of items to return" }, { "name": "order", "value": "asc", "type": "query", "description": "The order in which items are listed" }, { "name": "timestamp", "value": "", "type": "query", "description": "The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time." }, { "name": "transactiontype", "value": "null", "type": "query" }, { "name": "transactions", "value": "true", "type": "query", "description": "If provided and set to false transactions will not be included in the response" } ] }, "docs": "Return the account transactions and balance information given an account alias, an account id, or an evm address. The information will be limited to at most 1000 token balances for the account as outlined in HIP-367.\nWhen the timestamp parameter is supplied, we will return transactions and account state for the relevant timestamp query. Balance information will be accurate to within 15 minutes of the provided timestamp query.\nHistorical ethereum nonce information is currently not available and m" }, { "info": { "name": "List hooks for an account", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/accounts/:idOrAliasOrEvmAddress/hooks", "params": [ { "name": "idOrAliasOrEvmAddress", "value": "", "type": "path", "description": "Account alias or account id or evm address" }, { "name": "hook.id", "value": "1234", "type": "query", "description": "The ID of the hook" }, { "name": "limit", "value": "2", "type": "query", "description": "The maximum number of items to return" }, { "name": "order", "value": "asc", "type": "query", "description": "The order in which items are listed" } ] }, "docs": "Returns a list of hooks associated with a given account ID, alias, or EVM address." }, { "info": { "name": "Get hook storage slots", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/accounts/:idOrAliasOrEvmAddress/hooks/:hookId/storage", "params": [ { "name": "idOrAliasOrEvmAddress", "value": "", "type": "path", "description": "Account alias or account id or evm address" }, { "name": "hookId", "value": "1234", "type": "path", "description": "The ID of the hook" }, { "name": "key", "value": "", "type": "query", "description": "A string representing a pair of operator:address of a hook storage entry" }, { "name": "limit", "value": "2", "type": "query", "description": "The maximum number of items to return" }, { "name": "order", "value": "desc", "type": "query", "description": "The order in which items are listed" }, { "name": "timestamp", "value": "", "type": "query", "description": "The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time." } ] }, "docs": "Returns a list of hook storage slots associated with a given hook." }, { "info": { "name": "Get nfts for an account info", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/accounts/:idOrAliasOrEvmAddress/nfts", "params": [ { "name": "idOrAliasOrEvmAddress", "value": "", "type": "path", "description": "Account alias or account id or evm address" }, { "name": "limit", "value": "2", "type": "query", "description": "The maximum number of items to return" }, { "name": "order", "value": "asc", "type": "query", "description": "The order in which items are listed" }, { "name": "serialnumber", "value": "", "type": "query", "description": "The nft serial number (64 bit type). Requires a tokenId value also be populated." }, { "name": "spender.id", "value": "", "type": "query", "description": "The ID of the spender to return information for" }, { "name": "token.id", "value": "", "type": "query", "description": "The ID of the token to return information for" } ] }, "docs": "Returns information for all non-fungible tokens for an account.\n\n## Ordering\nWhen considering NFTs, their order is governed by a combination of their numerical **token.Id** and **serialnumber** values, with **token.id** being the parent column.\nA serialnumbers value governs its order within the given token.id\n\nIn that regard, if a user acquired a set of NFTs in the order (2-2, 2-4 1-5, 1-1, 1-3, 3-3, 3-4), the following layouts illustrate the ordering expectations for ownership listing\n1. **All " }, { "info": { "name": "Get past staking reward payouts for an account", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/accounts/:idOrAliasOrEvmAddress/rewards", "params": [ { "name": "idOrAliasOrEvmAddress", "value": "", "type": "path", "description": "Account alias or account id or evm address" }, { "name": "limit", "value": "2", "type": "query", "description": "The maximum number of items to return" }, { "name": "order", "value": "asc", "type": "query", "description": "The order in which items are listed" }, { "name": "timestamp", "value": "", "type": "query", "description": "The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time." } ] }, "docs": "Returns information for all past staking reward payouts for an account.\n" }, { "info": { "name": "Get token relationships info for an account", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/accounts/:idOrAliasOrEvmAddress/tokens", "params": [ { "name": "idOrAliasOrEvmAddress", "value": "", "type": "path", "description": "Account alias or account id or evm address" }, { "name": "limit", "value": "2", "type": "query", "description": "The maximum number of items to return" }, { "name": "order", "value": "desc", "type": "query", "description": "The order in which items are listed" }, { "name": "token.id", "value": "", "type": "query", "description": "The ID of the token to return information for" } ] }, "docs": "Returns information for all token relationships for an account.\n" }, { "info": { "name": "Get crypto allowances for an account info", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/accounts/:idOrAliasOrEvmAddress/allowances/crypto", "params": [ { "name": "idOrAliasOrEvmAddress", "value": "", "type": "path", "description": "Account alias or account id or evm address" }, { "name": "limit", "value": "2", "type": "query", "description": "The maximum number of items to return" }, { "name": "order", "value": "asc", "type": "query", "description": "The order in which items are listed" }, { "name": "spender.id", "value": "", "type": "query", "description": "The ID of the spender to return information for" } ] }, "docs": "Returns information for all crypto allowances for an account." }, { "info": { "name": "Get fungible token allowances for an account", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/accounts/:idOrAliasOrEvmAddress/allowances/tokens", "params": [ { "name": "idOrAliasOrEvmAddress", "value": "", "type": "path", "description": "Account alias or account id or evm address" }, { "name": "limit", "value": "2", "type": "query", "description": "The maximum number of items to return" }, { "name": "order", "value": "desc", "type": "query", "description": "The order in which items are listed" }, { "name": "spender.id", "value": "", "type": "query", "description": "The ID of the spender to return information for" }, { "name": "token.id", "value": "", "type": "query", "description": "The ID of the token to return information for" } ] }, "docs": "Returns information for fungible token allowances for an account.\n\n## Ordering\nThe order is governed by a combination of the spender id and the token id values, with spender id being the parent column.\nThe token id value governs its order within the given spender id.\n\nNote: The default order for this API is currently ASC\n\n## Filtering\nWhen filtering there are some restrictions enforced to ensure correctness and scalability.\n\n**The table below defines the restrictions and support for the endpoint" }, { "info": { "name": "Get non fungible token allowances for an account", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/accounts/:idOrAliasOrEvmAddress/allowances/nfts", "params": [ { "name": "idOrAliasOrEvmAddress", "value": "", "type": "path", "description": "Account alias or account id or evm address" }, { "name": "limit", "value": "2", "type": "query", "description": "The maximum number of items to return" }, { "name": "order", "value": "desc", "type": "query", "description": "The order in which items are listed" }, { "name": "account.id", "value": "", "type": "query", "description": "The ID of the account to return information for" }, { "name": "token.id", "value": "", "type": "query", "description": "The ID of the token to return information for" }, { "name": "owner", "value": "true", "type": "query", "description": "When the owner value is true or omitted, the accountId path parameter will specify the ID of the owner, and the API will retrieve the allowances that the owner has granted to different spenders. Conversely, when the owner value is false, the accountId path parameter will indicate the ID of the spender who has an allowance, and the API will instead provide the allowances granted to the spender by different owners of those tokens." } ] }, "docs": "Returns an account's non-fungible token allowances.\n\n## Ordering\nThe order is governed by a combination of the account ID and the token ID values, with account ID being the parent column.\nThe token ID value governs its order within the given account ID.\n\nNote: The default order for this API is currently ascending. The account ID can be the owner or the spender ID depending upon the owner flag.\n\n## Filtering\nWhen filtering there are some restrictions enforced to ensure correctness and scalability" } ] } ], "bundled": true }