indexer

AddWebhookListener

SecurityApiKeyAuth

Request

Request Body schema: application/json

	object (WebhookEventFilter)
projectId	number
url	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Indexer/AddWebhookListener

Request samples

application/json

{"filters": {"accounts": ["string"
],
"contractAddresses": ["string"
],
"tokenIDs": ["string"
]
},
"projectId": 0,
"url": "string"
}

Response samples

application/json

{"listener": {"filters": {"accounts": ["string"
],
"contractAddresses": ["string"
],
"tokenIDs": ["string"
]
},
"id": 0,
"projectID": 0,
"updatedAt": "string",
"url": "string"
},
"status": true
}

FetchTransactionReceipt

Fetches a single receipt and then will stop the subscription

SecurityApiKeyAuth

Request

Request Body schema: application/json

maxBlockWait	number
txnHash	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Indexer/FetchTransactionReceipt

Request samples

application/json

{"maxBlockWait": 0,
"txnHash": "string"
}

Response samples

application/json

{"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"
}
}

FetchTransactionReceiptWithFilter

Fetches a single receipt with filter and then will stop the subscription

SecurityApiKeyAuth

Request

Request Body schema: application/json

	object (Filter)
maxBlockWait	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Indexer/FetchTransactionReceiptWithFilter

Request samples

application/json

{"filter": {"properties": [{"max": 0,
"min": 0,
"name": "string",
"type": "INT",
"values": [{ }
]
}
],
"text": "string"
},
"maxBlockWait": 0
}

Response samples

application/json

{"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"
}
}

GetAllWebhookListeners

SecurityApiKeyAuth

Request

Request Body schema: application/json

projectId

number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetAllWebhookListeners

Request samples

application/json

{"projectId": 0
}

Response samples

application/json

{"listeners": [{"filters": {"accounts": ["string"
],
"contractAddresses": ["string"
],
"tokenIDs": ["string"
]
},
"id": 0,
"projectID": 0,
"updatedAt": "string",
"url": "string"
}
]
}

GetBalanceUpdates

Get balance update aggregate values -- useful for syncing balance details of a contract, ie. from Skyweaver

SecurityApiKeyAuth

Request

Request Body schema: application/json

contractAddress	string
lastBlockHash	string
lastBlockNumber	number
	object (Page)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetBalanceUpdates

Request samples

application/json

{"contractAddress": "string",
"lastBlockHash": "string",
"lastBlockNumber": 0,
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

Response samples

application/json

{"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",
"link": "string",
"ogImage": "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
}
}

GetChainID

Get the chain ID of the indexer

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (Indexer_GetChainID_Request)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetChainID

Request samples

application/json

{ }

Response samples

application/json

{"chainID": 0
}

GetEtherBalance

Queries an ethereum node for the latest and confirm ETH balances

SecurityApiKeyAuth

Request

Request Body schema: application/json

accountAddress

string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetEtherBalance

Request samples

application/json

{"accountAddress": "string"
}

Response samples

application/json

{"balance": {"accountAddress": "string",
"balanceWei": "string"
}
}

GetOrderbookOrders

Fetch orderbook orders

SecurityApiKeyAuth

Request

Request Body schema: application/json

beforeExpiryTimestamp	number
collectionAddress	string
currencyAddresses	Array of strings []string
	Array of objects (OrderbookOrderFilter) []OrderbookOrderFilter
orderStatuses	Array of strings (OrderStatus) []OrderStatus Items Enum: "OPEN" "CLOSED" "CANCELLED"
orderbookContractAddress	string
	object (Page)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetOrderbookOrders

Request samples

application/json

{"beforeExpiryTimestamp": 0,
"collectionAddress": "string",
"currencyAddresses": ["string"
],
"filters": [{"isListing": true,
"tokenIds": ["string"
],
"userAddress": "string"
}
],
"orderStatuses": ["OPEN"
],
"orderbookContractAddress": "string",
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

Response samples

application/json

{"orders": [{"createdAt": 0,
"createdBy": "string",
"currencyAddress": "string",
"expiry": "string",
"isListing": true,
"orderId": "string",
"orderStatus": "OPEN",
"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

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.

SecurityApiKeyAuth

Request

Request Body schema: application/json

accountAddress	string
contractAddress	string
includeCollectionTokens	boolean
includeMetadata	boolean
	object (MetadataOptions)
	object (Page)
tokenID	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetTokenBalances

Request samples

application/json

{"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"
}

Response samples

application/json

{"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",
"link": "string",
"ogImage": "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

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.

SecurityApiKeyAuth

Request

Request Body schema: application/json

contractAddress	string
includeMetadata	boolean
	object (MetadataOptions)
	object (Page)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetTokenSupplies

Request samples

application/json

{"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
}
}

Response samples

application/json

{"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",
"link": "string",
"ogImage": "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

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'] }

SecurityApiKeyAuth

Request

Request Body schema: application/json

includeMetadata	boolean
	object (MetadataOptions)
	object map<string,[]string>

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetTokenSuppliesMap

Request samples

application/json

{"includeMetadata": true,
"metadataOptions": {"includeContracts": ["string"
],
"unverifiedOnly": true,
"verifiedOnly": true
},
"tokenMap": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

application/json

{"supplies": {"property1": [{"chainId": 0,
"contractInfo": {"address": "string",
"bytecodeHash": "string",
"chainId": 0,
"contentHash": 0,
"decimals": 0,
"deployed": true,
"extensions": {"blacklist": true,
"description": "string",
"link": "string",
"ogImage": "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",
"link": "string",
"ogImage": "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"
}
}
]
}
}

GetTopOrders

SecurityApiKeyAuth

Request

Request Body schema: application/json

collectionAddress	string
currencyAddresses	Array of strings []string
excludeUser	string
isListing	boolean
orderbookContractAddress	string
priceSort	string (SortOrder) Represented as uint32 on the server side Enum: "DESC" "ASC"
tokenIDs	Array of strings []string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetTopOrders

Request samples

application/json

{"collectionAddress": "string",
"currencyAddresses": ["string"
],
"excludeUser": "string",
"isListing": true,
"orderbookContractAddress": "string",
"priceSort": "DESC",
"tokenIDs": ["string"
]
}

Response samples

application/json

{"orders": [{"createdAt": 0,
"createdBy": "string",
"currencyAddress": "string",
"expiry": "string",
"isListing": true,
"orderId": "string",
"orderStatus": "OPEN",
"orderbookContractAddress": "string",
"pricePerToken": "string",
"quantity": "string",
"quantityRemaining": "string",
"tokenContract": "string",
"tokenId": "string"
}
]
}

GetTransactionHistory

History of mined transactions for the account which includes a list of token transfers (sent/recieved) and sent transactions from a Sequence wallet

SecurityApiKeyAuth

Request

Request Body schema: application/json

	object (TransactionHistoryFilter)
includeMetadata	boolean
	object (MetadataOptions)
	object (Page)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetTransactionHistory

Request samples

application/json

{"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
}
}

Response samples

application/json

{"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"
}
}
}
]
}

GetWebhookListener

SecurityApiKeyAuth

Request

Request Body schema: application/json

id	number
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetWebhookListener

Request samples

application/json

{"id": 0,
"projectId": 0
}

Response samples

application/json

{"listener": {"filters": {"accounts": ["string"
],
"contractAddresses": ["string"
],
"tokenIDs": ["string"
]
},
"id": 0,
"projectID": 0,
"updatedAt": "string",
"url": "string"
}
}

Ping

Ping the indexer

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (Indexer_Ping_Request)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Indexer/Ping

Request samples

application/json

{ }

Response samples

application/json

{"status": true
}

RemoveWebhookListener

SecurityApiKeyAuth

Request

Request Body schema: application/json

id	number
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Indexer/RemoveWebhookListener

Request samples

application/json

{"id": 0,
"projectId": 0
}

Response samples

application/json

{"status": true
}

RuntimeStatus

Get the current runtime health status of the indexer

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (Indexer_RuntimeStatus_Request)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Indexer/RuntimeStatus

Request samples

application/json

{ }

Response samples

application/json

{"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"
}
}

SyncBalance

Re-sync an incorrect token balance with the correct on-chain balance

SecurityApiKeyAuth

Request

Request Body schema: application/json

accountAddress	string
contractAddress	string
tokenID	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Indexer/SyncBalance

Request samples

application/json

{"accountAddress": "string",
"contractAddress": "string",
"tokenID": "string"
}

Response samples

application/json

{ }

UpdateWebhookListener

SecurityApiKeyAuth

Request

Request Body schema: application/json

	object (WebhookListener)
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Indexer/UpdateWebhookListener

Request samples

application/json

{"listener": {"filters": {"accounts": ["string"
],
"contractAddresses": ["string"
],
"tokenIDs": ["string"
]
},
"id": 0,
"projectID": 0,
"updatedAt": "string",
"url": "string"
},
"projectId": 0
}

Response samples

application/json

{"status": true
}

Version

Get the current version of the indexer

SecurityApiKeyAuth

Request

Request Body schema: application/json

object (Indexer_Version_Request)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Indexer/Version

Request samples

application/json

{ }

Response samples

application/json

{"version": {"appVersion": "string",
"schemaHash": "string",
"schemaVersion": "string",
"webrpcVersion": "string"
}
}

➔ Next to marketplace