indexer

AddWebhookListener

SecurityApiKeyAuth
Request
Request Body schema: application/json
object (EventFilter)
projectId
number
url
string
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/Indexer/AddWebhookListener
Request samples
application/json
{
  • "filters": {
    },
  • "projectId": 0,
  • "url": "string"
}
Response samples
application/json
{
  • "listener": {
    },
  • "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

OK

4XX

Client error

5XX

Server error

post/rpc/Indexer/FetchTransactionReceipt
Request samples
application/json
{
  • "maxBlockWait": 0,
  • "txnHash": "string"
}
Response samples
application/json
{
  • "receipt": {
    }
}

FetchTransactionReceiptWithFilter

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

SecurityApiKeyAuth
Request
Request Body schema: application/json
object (TransactionFilter)
maxBlockWait
number
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/Indexer/FetchTransactionReceiptWithFilter
Request samples
application/json
{
  • "filter": {
    },
  • "maxBlockWait": 0
}
Response samples
application/json
{
  • "receipt": {
    }
}

GetAllWebhookListeners

SecurityApiKeyAuth
Request
Request Body schema: application/json
projectId
number
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetAllWebhookListeners
Request samples
application/json
{
  • "projectId": 0
}
Response samples
application/json
{
  • "listeners": [
    ]
}

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

OK

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetBalanceUpdates
Request samples
application/json
{
  • "contractAddress": "string",
  • "lastBlockHash": "string",
  • "lastBlockNumber": 0,
  • "page": {
    }
}
Response samples
application/json
{
  • "balances": [
    ],
  • "page": {
    }
}

GetChainID

Get the chain ID of the indexer

SecurityApiKeyAuth
Request
Request Body schema: application/json
object (Indexer_GetChainID_Request)
Responses
200

OK

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

OK

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetEtherBalance
Request samples
application/json
{
  • "accountAddress": "string"
}
Response samples
application/json
{
  • "balance": {
    }
}

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

OK

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetOrderbookOrders
Request samples
application/json
{
  • "beforeExpiryTimestamp": 0,
  • "collectionAddress": "string",
  • "currencyAddresses": [
    ],
  • "filters": [
    ],
  • "orderStatuses": [
    ],
  • "orderbookContractAddress": "string",
  • "page": {
    }
}
Response samples
application/json
{
  • "orders": [
    ],
  • "page": {
    }
}

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

OK

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetTokenBalances
Request samples
application/json
{
  • "accountAddress": "string",
  • "contractAddress": "string",
  • "includeCollectionTokens": true,
  • "includeMetadata": true,
  • "metadataOptions": {
    },
  • "page": {
    },
  • "tokenID": "string"
}
Response samples
application/json
{
  • "balances": [
    ],
  • "page": {
    }
}

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

OK

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetTokenSupplies
Request samples
application/json
{
  • "contractAddress": "string",
  • "includeMetadata": true,
  • "metadataOptions": {
    },
  • "page": {
    }
}
Response samples
application/json
{
  • "contractType": "UNKNOWN",
  • "page": {
    },
  • "tokenIDs": [
    ]
}

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

OK

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetTokenSuppliesMap
Request samples
application/json
{
  • "includeMetadata": true,
  • "metadataOptions": {
    },
  • "tokenMap": {
    }
}
Response samples
application/json
{
  • "supplies": {
    }
}

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

OK

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetTopOrders
Request samples
application/json
{
  • "collectionAddress": "string",
  • "currencyAddresses": [
    ],
  • "excludeUser": "string",
  • "isListing": true,
  • "orderbookContractAddress": "string",
  • "priceSort": "DESC",
  • "tokenIDs": [
    ]
}
Response samples
application/json
{
  • "orders": [
    ]
}

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

OK

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetTransactionHistory
Request samples
application/json
{
  • "filter": {
    },
  • "includeMetadata": true,
  • "metadataOptions": {
    },
  • "page": {
    }
}
Response samples
application/json
{
  • "page": {
    },
  • "transactions": [
    ]
}

GetWebhookListener

SecurityApiKeyAuth
Request
Request Body schema: application/json
id
number
projectId
number
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/Indexer/GetWebhookListener
Request samples
application/json
{
  • "id": 0,
  • "projectId": 0
}
Response samples
application/json
{
  • "listener": {
    }
}

Ping

Ping the indexer

SecurityApiKeyAuth
Request
Request Body schema: application/json
object (Indexer_Ping_Request)
Responses
200

OK

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

OK

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

OK

4XX

Client error

5XX

Server error

post/rpc/Indexer/RuntimeStatus
Request samples
application/json
{ }
Response samples
application/json
{
  • "status": {
    }
}

SubscribeBalanceUpdates

SecurityApiKeyAuth
Request
Request Body schema: application/json
contractAddress
string
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/Indexer/SubscribeBalanceUpdates
Request samples
application/json
{
  • "contractAddress": "string"
}
Response samples
application/json
{
  • "balance": {
    }
}

SubscribeEvents

TODO: pass optional block ... can pass too, reorg true, etc. or stay behind, etc.

SecurityApiKeyAuth
Request
Request Body schema: application/json
object (EventFilter)
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/Indexer/SubscribeEvents
Request samples
application/json
{
  • "filter": {
    }
}
Response samples
application/json
{
  • "log": {
    }
}

SubscribeReceipts

SecurityApiKeyAuth
Request
Request Body schema: application/json
object (TransactionFilter)
Responses
200

OK

4XX

Client error

5XX

Server error

post/rpc/Indexer/SubscribeReceipts
Request samples
application/json
{
  • "filter": {
    }
}
Response samples
application/json
{
  • "receipt": {
    }
}

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

OK

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

OK

4XX

Client error

5XX

Server error

post/rpc/Indexer/UpdateWebhookListener
Request samples
application/json
{
  • "listener": {
    },
  • "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

OK

4XX

Client error

5XX

Server error

post/rpc/Indexer/Version
Request samples
application/json
{ }
Response samples
application/json
{
  • "version": {
    }
}