{- "filters": {
- "accounts": [
- "string"
], - "contractAddresses": [
- "string"
], - "events": [
- "string"
], - "tokenIDs": [
- "string"
]
}, - "projectId": 0,
- "url": "string"
}
{- "listener": {
- "active": true,
- "filters": {
- "accounts": [
- "string"
], - "contractAddresses": [
- "string"
], - "events": [
- "string"
], - "tokenIDs": [
- "string"
]
}, - "id": 0,
- "name": "string",
- "projectID": 0,
- "updatedAt": "string",
- "url": "string"
}, - "status": true
}
Fetches a single receipt and then will stop the subscription
OK
Client error
Server error
{- "maxBlockWait": 0,
- "txnHash": "string"
}
{- "receipt": {
- "blockHash": "string",
- "blockNumber": 0,
- "effectiveGasPrice": "string",
- "final": true,
- "from": "string",
- "gasUsed": 0,
- "logs": [
- {
- "contractAddress": "string",
- "data": "string",
- "index": 0,
- "topics": [
- "string"
]
}
], - "reorged": true,
- "to": "string",
- "txnHash": "string",
- "txnIndex": 0,
- "txnStatus": "FAILED",
- "txnType": "LegacyTxnType"
}
}
Fetches a single receipt with filter and then will stop the subscription
OK
Client error
Server error
{- "filter": {
- "contractAddress": "string",
- "event": "string",
- "from": "string",
- "to": "string",
- "txnHash": "string"
}, - "maxBlockWait": 0
}
{- "receipt": {
- "blockHash": "string",
- "blockNumber": 0,
- "effectiveGasPrice": "string",
- "final": true,
- "from": "string",
- "gasUsed": 0,
- "logs": [
- {
- "contractAddress": "string",
- "data": "string",
- "index": 0,
- "topics": [
- "string"
]
}
], - "reorged": true,
- "to": "string",
- "txnHash": "string",
- "txnIndex": 0,
- "txnStatus": "FAILED",
- "txnType": "LegacyTxnType"
}
}
{- "projectId": 0
}
{- "listeners": [
- {
- "active": true,
- "filters": {
- "accounts": [
- "string"
], - "contractAddresses": [
- "string"
], - "events": [
- "string"
], - "tokenIDs": [
- "string"
]
}, - "id": 0,
- "name": "string",
- "projectID": 0,
- "updatedAt": "string",
- "url": "string"
}
]
}
Get balance update aggregate values -- useful for syncing balance details of a contract, ie. from Skyweaver
OK
Client error
Server error
{- "contractAddress": "string",
- "lastBlockHash": "string",
- "lastBlockNumber": 0,
- "page": {
- "after": { },
- "before": { },
- "column": "string",
- "more": true,
- "page": 0,
- "pageSize": 0,
- "sort": [
- {
- "column": "string",
- "order": "DESC"
}
], - "totalRecords": 0
}
}
{- "balances": [
- {
- "accountAddress": "string",
- "balance": "string",
- "blockHash": "string",
- "blockNumber": 0,
- "chainId": 0,
- "contractAddress": "string",
- "contractInfo": {
- "address": "string",
- "bytecodeHash": "string",
- "chainId": 0,
- "contentHash": 0,
- "decimals": 0,
- "deployed": true,
- "extensions": {
- "blacklist": true,
- "description": "string",
- "featured": true,
- "link": "string",
- "ogImage": "string",
- "ogName": "string",
- "originAddress": "string",
- "originChainId": 0,
- "verified": true,
- "verifiedBy": "string"
}, - "logoURI": "string",
- "name": "string",
- "symbol": "string",
- "type": "string",
- "updatedAt": "string"
}, - "contractType": "UNKNOWN",
- "isNFTSummary": true,
- "tokenID": "string",
- "tokenMetadata": {
- "animationUrl": "string",
- "assets": [
- {
- "collectionId": 0,
- "filename": "string",
- "filesize": 0,
- "height": 0,
- "id": 0,
- "metadataField": "string",
- "mimeType": "string",
- "tokenId": "string",
- "updatedAt": "string",
- "url": "string",
- "width": 0
}
], - "attributes": [
- {
- "property1": { },
- "property2": { }
}
], - "audio": "string",
- "backgroundColor": "string",
- "decimals": 0,
- "description": "string",
- "externalUrl": "string",
- "image": "string",
- "imageData": "string",
- "name": "string",
- "properties": {
- "property1": { },
- "property2": { }
}, - "tokenId": "string",
- "updatedAt": "string",
- "video": "string"
}
}
], - "page": {
- "after": { },
- "before": { },
- "column": "string",
- "more": true,
- "page": 0,
- "pageSize": 0,
- "sort": [
- {
- "column": "string",
- "order": "DESC"
}
], - "totalRecords": 0
}
}
Get the chain ID of the indexer
OK
Client error
Server error
{ }
{- "chainID": 0
}
Queries an ethereum node for the latest and confirm ETH balances
OK
Client error
Server error
{- "accountAddress": "string"
}
{- "balance": {
- "accountAddress": "string",
- "balanceWei": "string"
}
}
Fetch orderbook orders
OK
Client error
Server error
{- "beforeExpiryTimestamp": 0,
- "collectionAddress": "string",
- "currencyAddresses": [
- "string"
], - "filters": [
- {
- "excludeUserAddress": "string",
- "isListing": true,
- "tokenIds": [
- "string"
], - "userAddress": "string"
}
], - "orderStatuses": [
- "unknown"
], - "orderbookContractAddress": "string",
- "page": {
- "after": { },
- "before": { },
- "column": "string",
- "more": true,
- "page": 0,
- "pageSize": 0,
- "sort": [
- {
- "column": "string",
- "order": "DESC"
}
], - "totalRecords": 0
}
}
{- "orders": [
- {
- "createdAt": 0,
- "createdBy": "string",
- "currencyAddress": "string",
- "expiry": "string",
- "isListing": true,
- "orderId": "string",
- "orderStatus": "unknown",
- "orderbookContractAddress": "string",
- "pricePerToken": "string",
- "quantity": "string",
- "quantityRemaining": "string",
- "tokenContract": "string",
- "tokenId": "string"
}
], - "page": {
- "after": { },
- "before": { },
- "column": "string",
- "more": true,
- "page": 0,
- "pageSize": 0,
- "sort": [
- {
- "column": "string",
- "order": "DESC"
}
], - "totalRecords": 0
}
}
GetTokenBalances returns a balance summary/details for a specific account. By default if accountAddress is left empty, it will use the account from the jwt session. Also, if contractAddress is undefined, then it will list all current user coins/collectibles. But, if contractAddress is provided, then it will return the token balances for the contract, this is only useful for 1155, but for other tokens, it can act as a filter for the single balance.
OK
Client error
Server error
{- "accountAddress": "string",
- "contractAddress": "string",
- "includeCollectionTokens": true,
- "includeMetadata": true,
- "metadataOptions": {
- "includeContracts": [
- "string"
], - "unverifiedOnly": true,
- "verifiedOnly": true
}, - "page": {
- "after": { },
- "before": { },
- "column": "string",
- "more": true,
- "page": 0,
- "pageSize": 0,
- "sort": [
- {
- "column": "string",
- "order": "DESC"
}
], - "totalRecords": 0
}, - "tokenID": "string"
}
{- "balances": [
- {
- "accountAddress": "string",
- "balance": "string",
- "blockHash": "string",
- "blockNumber": 0,
- "chainId": 0,
- "contractAddress": "string",
- "contractInfo": {
- "address": "string",
- "bytecodeHash": "string",
- "chainId": 0,
- "contentHash": 0,
- "decimals": 0,
- "deployed": true,
- "extensions": {
- "blacklist": true,
- "description": "string",
- "featured": true,
- "link": "string",
- "ogImage": "string",
- "ogName": "string",
- "originAddress": "string",
- "originChainId": 0,
- "verified": true,
- "verifiedBy": "string"
}, - "logoURI": "string",
- "name": "string",
- "symbol": "string",
- "type": "string",
- "updatedAt": "string"
}, - "contractType": "UNKNOWN",
- "isNFTSummary": true,
- "tokenID": "string",
- "tokenMetadata": {
- "animationUrl": "string",
- "assets": [
- {
- "collectionId": 0,
- "filename": "string",
- "filesize": 0,
- "height": 0,
- "id": 0,
- "metadataField": "string",
- "mimeType": "string",
- "tokenId": "string",
- "updatedAt": "string",
- "url": "string",
- "width": 0
}
], - "attributes": [
- {
- "property1": { },
- "property2": { }
}
], - "audio": "string",
- "backgroundColor": "string",
- "decimals": 0,
- "description": "string",
- "externalUrl": "string",
- "image": "string",
- "imageData": "string",
- "name": "string",
- "properties": {
- "property1": { },
- "property2": { }
}, - "tokenId": "string",
- "updatedAt": "string",
- "video": "string"
}
}
], - "page": {
- "after": { },
- "before": { },
- "column": "string",
- "more": true,
- "page": 0,
- "pageSize": 0,
- "sort": [
- {
- "column": "string",
- "order": "DESC"
}
], - "totalRecords": 0
}
}
GetTokenSupplies returns the set of tokenIDs used by a contract address, supporting ERC-20, ERC-721, and ERC-1155 contracts, and their respective supply as well.
OK
Client error
Server error
{- "contractAddress": "string",
- "includeMetadata": true,
- "metadataOptions": {
- "includeContracts": [
- "string"
], - "unverifiedOnly": true,
- "verifiedOnly": true
}, - "page": {
- "after": { },
- "before": { },
- "column": "string",
- "more": true,
- "page": 0,
- "pageSize": 0,
- "sort": [
- {
- "column": "string",
- "order": "DESC"
}
], - "totalRecords": 0
}
}
{- "contractType": "UNKNOWN",
- "page": {
- "after": { },
- "before": { },
- "column": "string",
- "more": true,
- "page": 0,
- "pageSize": 0,
- "sort": [
- {
- "column": "string",
- "order": "DESC"
}
], - "totalRecords": 0
}, - "tokenIDs": [
- {
- "chainId": 0,
- "contractInfo": {
- "address": "string",
- "bytecodeHash": "string",
- "chainId": 0,
- "contentHash": 0,
- "decimals": 0,
- "deployed": true,
- "extensions": {
- "blacklist": true,
- "description": "string",
- "featured": true,
- "link": "string",
- "ogImage": "string",
- "ogName": "string",
- "originAddress": "string",
- "originChainId": 0,
- "verified": true,
- "verifiedBy": "string"
}, - "logoURI": "string",
- "name": "string",
- "symbol": "string",
- "type": "string",
- "updatedAt": "string"
}, - "supply": "string",
- "tokenID": "string",
- "tokenMetadata": {
- "animationUrl": "string",
- "assets": [
- {
- "collectionId": 0,
- "filename": "string",
- "filesize": 0,
- "height": 0,
- "id": 0,
- "metadataField": "string",
- "mimeType": "string",
- "tokenId": "string",
- "updatedAt": "string",
- "url": "string",
- "width": 0
}
], - "attributes": [
- {
- "property1": { },
- "property2": { }
}
], - "audio": "string",
- "backgroundColor": "string",
- "decimals": 0,
- "description": "string",
- "externalUrl": "string",
- "image": "string",
- "imageData": "string",
- "name": "string",
- "properties": {
- "property1": { },
- "property2": { }
}, - "tokenId": "string",
- "updatedAt": "string",
- "video": "string"
}
}
]
}
GetTokenSuppliesMap returns the token supplies of ERC-20 and ERC-1155 tokens as requested in the tokenMap
represented as a map of contractAddress :: []tokenIDs.
For an ERC-20 specify tokenIDs as an empty array or [0], for example, { '0xdef': [] } or { '0xdef': [0] } For ERC-1155 pass the array of tokens are strings, ie. { '0xabc': ['1', '2', '3'] }
OK
Client error
Server error
{- "includeMetadata": true,
- "metadataOptions": {
- "includeContracts": [
- "string"
], - "unverifiedOnly": true,
- "verifiedOnly": true
}, - "tokenMap": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
{- "supplies": {
- "property1": [
- {
- "chainId": 0,
- "contractInfo": {
- "address": "string",
- "bytecodeHash": "string",
- "chainId": 0,
- "contentHash": 0,
- "decimals": 0,
- "deployed": true,
- "extensions": {
- "blacklist": true,
- "description": "string",
- "featured": true,
- "link": "string",
- "ogImage": "string",
- "ogName": "string",
- "originAddress": "string",
- "originChainId": 0,
- "verified": true,
- "verifiedBy": "string"
}, - "logoURI": "string",
- "name": "string",
- "symbol": "string",
- "type": "string",
- "updatedAt": "string"
}, - "supply": "string",
- "tokenID": "string",
- "tokenMetadata": {
- "animationUrl": "string",
- "assets": [
- {
- "collectionId": 0,
- "filename": "string",
- "filesize": 0,
- "height": 0,
- "id": 0,
- "metadataField": "string",
- "mimeType": "string",
- "tokenId": "string",
- "updatedAt": "string",
- "url": "string",
- "width": 0
}
], - "attributes": [
- {
- "property1": { },
- "property2": { }
}
], - "audio": "string",
- "backgroundColor": "string",
- "decimals": 0,
- "description": "string",
- "externalUrl": "string",
- "image": "string",
- "imageData": "string",
- "name": "string",
- "properties": {
- "property1": { },
- "property2": { }
}, - "tokenId": "string",
- "updatedAt": "string",
- "video": "string"
}
}
], - "property2": [
- {
- "chainId": 0,
- "contractInfo": {
- "address": "string",
- "bytecodeHash": "string",
- "chainId": 0,
- "contentHash": 0,
- "decimals": 0,
- "deployed": true,
- "extensions": {
- "blacklist": true,
- "description": "string",
- "featured": true,
- "link": "string",
- "ogImage": "string",
- "ogName": "string",
- "originAddress": "string",
- "originChainId": 0,
- "verified": true,
- "verifiedBy": "string"
}, - "logoURI": "string",
- "name": "string",
- "symbol": "string",
- "type": "string",
- "updatedAt": "string"
}, - "supply": "string",
- "tokenID": "string",
- "tokenMetadata": {
- "animationUrl": "string",
- "assets": [
- {
- "collectionId": 0,
- "filename": "string",
- "filesize": 0,
- "height": 0,
- "id": 0,
- "metadataField": "string",
- "mimeType": "string",
- "tokenId": "string",
- "updatedAt": "string",
- "url": "string",
- "width": 0
}
], - "attributes": [
- {
- "property1": { },
- "property2": { }
}
], - "audio": "string",
- "backgroundColor": "string",
- "decimals": 0,
- "description": "string",
- "externalUrl": "string",
- "image": "string",
- "imageData": "string",
- "name": "string",
- "properties": {
- "property1": { },
- "property2": { }
}, - "tokenId": "string",
- "updatedAt": "string",
- "video": "string"
}
}
]
}
}
{- "collectionAddress": "string",
- "currencyAddresses": [
- "string"
], - "excludeUser": "string",
- "isListing": true,
- "orderbookContractAddress": "string",
- "priceSort": "DESC",
- "tokenIDs": [
- "string"
]
}
{- "orders": [
- {
- "createdAt": 0,
- "createdBy": "string",
- "currencyAddress": "string",
- "expiry": "string",
- "isListing": true,
- "orderId": "string",
- "orderStatus": "unknown",
- "orderbookContractAddress": "string",
- "pricePerToken": "string",
- "quantity": "string",
- "quantityRemaining": "string",
- "tokenContract": "string",
- "tokenId": "string"
}
]
}
History of mined transactions for the account which includes a list of token transfers (sent/recieved) and sent transactions from a Sequence wallet
OK
Client error
Server error
{- "filter": {
- "accountAddress": "string",
- "accountAddresses": [
- "string"
], - "contractAddress": "string",
- "contractAddresses": [
- "string"
], - "fromBlock": 0,
- "metaTransactionIDs": [
- "string"
], - "toBlock": 0,
- "tokenID": "string",
- "transactionHashes": [
- "string"
]
}, - "includeMetadata": true,
- "metadataOptions": {
- "includeContracts": [
- "string"
], - "unverifiedOnly": true,
- "verifiedOnly": true
}, - "page": {
- "after": { },
- "before": { },
- "column": "string",
- "more": true,
- "page": 0,
- "pageSize": 0,
- "sort": [
- {
- "column": "string",
- "order": "DESC"
}
], - "totalRecords": 0
}
}
{- "page": {
- "after": { },
- "before": { },
- "column": "string",
- "more": true,
- "page": 0,
- "pageSize": 0,
- "sort": [
- {
- "column": "string",
- "order": "DESC"
}
], - "totalRecords": 0
}, - "transactions": [
- {
- "blockNumber": 0,
- "chainId": 0,
- "metaTxnID": "string",
- "timestamp": "string",
- "transfers": [
- {
- "amounts": [
- "string"
], - "contractAddress": "string",
- "from": "string",
- "ids": [
- "string"
], - "to": "string",
- "transferType": "SEND"
}
], - "txnHash": "string",
- "users": {
- "property1": {
- "username": "string"
}, - "property2": {
- "username": "string"
}
}
}
]
}
{- "id": 0,
- "projectId": 0
}
{- "listener": {
- "active": true,
- "filters": {
- "accounts": [
- "string"
], - "contractAddresses": [
- "string"
], - "events": [
- "string"
], - "tokenIDs": [
- "string"
]
}, - "id": 0,
- "name": "string",
- "projectID": 0,
- "updatedAt": "string",
- "url": "string"
}
}
Get the current runtime health status of the indexer
OK
Client error
Server error
{ }
{- "status": {
- "branch": "string",
- "checks": { },
- "commitHash": "string",
- "healthOK": true,
- "numTxnsRelayed": {
- "current": 0,
- "period": 0,
- "prev": 0
}, - "senders": [
- {
- "active": true,
- "address": "string",
- "etherBalance": 0,
- "index": 0
}
], - "startTime": "string",
- "uptime": 0,
- "useEIP1559": true,
- "ver": "string"
}
}
{- "contractAddress": "string"
}
{- "balance": {
- "accountAddress": "string",
- "balance": "string",
- "blockHash": "string",
- "blockNumber": 0,
- "chainId": 0,
- "contractAddress": "string",
- "contractInfo": {
- "address": "string",
- "bytecodeHash": "string",
- "chainId": 0,
- "contentHash": 0,
- "decimals": 0,
- "deployed": true,
- "extensions": {
- "blacklist": true,
- "description": "string",
- "featured": true,
- "link": "string",
- "ogImage": "string",
- "ogName": "string",
- "originAddress": "string",
- "originChainId": 0,
- "verified": true,
- "verifiedBy": "string"
}, - "logoURI": "string",
- "name": "string",
- "symbol": "string",
- "type": "string",
- "updatedAt": "string"
}, - "contractType": "UNKNOWN",
- "isNFTSummary": true,
- "tokenID": "string",
- "tokenMetadata": {
- "animationUrl": "string",
- "assets": [
- {
- "collectionId": 0,
- "filename": "string",
- "filesize": 0,
- "height": 0,
- "id": 0,
- "metadataField": "string",
- "mimeType": "string",
- "tokenId": "string",
- "updatedAt": "string",
- "url": "string",
- "width": 0
}
], - "attributes": [
- {
- "property1": { },
- "property2": { }
}
], - "audio": "string",
- "backgroundColor": "string",
- "decimals": 0,
- "description": "string",
- "externalUrl": "string",
- "image": "string",
- "imageData": "string",
- "name": "string",
- "properties": {
- "property1": { },
- "property2": { }
}, - "tokenId": "string",
- "updatedAt": "string",
- "video": "string"
}
}
}
TODO: pass optional block ... can pass too, reorg true, etc. or stay behind, etc.
object (EventFilter) |
OK
Client error
Server error
{- "filter": {
- "accounts": [
- "string"
], - "contractAddresses": [
- "string"
], - "events": [
- "string"
], - "tokenIDs": [
- "string"
]
}
}
{- "log": {
- "blockHash": "string",
- "blockNumber": 0,
- "contractAddress": "string",
- "contractType": "UNKNOWN",
- "event": {
- "eventSig": "string",
- "names": [
- "string"
], - "topicHash": "string",
- "types": [
- "string"
], - "values": [
- "string"
]
}, - "id": 0,
- "logDataType": "EVENT",
- "parentBlockHash": "string",
- "rawLog": {
- "property1": { },
- "property2": { }
}, - "ts": "string",
- "txnHash": "string",
- "txnIndex": 0,
- "txnInfo": {
- "from": "string",
- "to": "string",
- "value": "string"
}, - "txnLogIndex": 0,
- "type": "UNKNOWN",
- "uid": "string"
}
}
object (TransactionFilter) |
OK
Client error
Server error
{- "filter": {
- "contractAddress": "string",
- "event": "string",
- "from": "string",
- "to": "string",
- "txnHash": "string"
}
}
{- "receipt": {
- "blockHash": "string",
- "blockNumber": 0,
- "effectiveGasPrice": "string",
- "final": true,
- "from": "string",
- "gasUsed": 0,
- "logs": [
- {
- "contractAddress": "string",
- "data": "string",
- "index": 0,
- "topics": [
- "string"
]
}
], - "reorged": true,
- "to": "string",
- "txnHash": "string",
- "txnIndex": 0,
- "txnStatus": "FAILED",
- "txnType": "LegacyTxnType"
}
}
Re-sync an incorrect token balance with the correct on-chain balance
OK
Client error
Server error
{- "accountAddress": "string",
- "contractAddress": "string",
- "tokenID": "string"
}
{ }
{- "id": 0,
- "projectId": 0
}
{- "webhookListener": {
- "active": true,
- "filters": {
- "accounts": [
- "string"
], - "contractAddresses": [
- "string"
], - "events": [
- "string"
], - "tokenIDs": [
- "string"
]
}, - "id": 0,
- "name": "string",
- "projectID": 0,
- "updatedAt": "string",
- "url": "string"
}
}
{- "listener": {
- "active": true,
- "filters": {
- "accounts": [
- "string"
], - "contractAddresses": [
- "string"
], - "events": [
- "string"
], - "tokenIDs": [
- "string"
]
}, - "id": 0,
- "name": "string",
- "projectID": 0,
- "updatedAt": "string",
- "url": "string"
}, - "projectId": 0
}
{- "status": true
}
Get the current version of the indexer
OK
Client error
Server error
{ }
{- "version": {
- "appVersion": "string",
- "schemaHash": "string",
- "schemaVersion": "string",
- "webrpcVersion": "string"
}
}