/ethereals
GET
/ethereals
The /etherals
endpoint returns details of all ethereals for the given query parameters
Headers
x-api-key
Your API key
Params
chain
No
mainnet
The chain type we are working with, either mainnet
or sepolia
sourceChains
No
A comma separated list of the source chain that the mirrored NFT is from must be from, e.g. 1,42161
sourceContracts
No
A comma separated list of source contracts.
statuses
No
A comma separated list statuses to filter by Possible values: - active - unfunded
page_size
No
50
The number of records to return per page.
cursor
No
null
The cursor representing the start point of the next page of results.
Response Body
The response provides an array of etherealData
objects with a single nextCursor
value providing the cursor for the next page. If this is null there is no next page.
The etherealData
objects have the following properties:
_id
string
The unique Id for this transfer
ethereal
string
The contract address of the ethereal collection.
status
string
The status of the ethereal. Possible values are: - active - unfunded (funds are below the level required for synchronisation.
balance
string
The balance of the ethereal contract.
sourceChain
string
The source chain for the contract being mirrored..
sourceContract
string
The source contract being mirrored.
tokenName
string
The name of the ethereal contract.
tokenSymbol
string
The symbol of the ethereal contract.
lastCheckedTimestamp
number
Unix timestamp of when this was last checked.
lastCheckedDate
string
Date object of when this was last checked.
lastSyncTimestamp
number
Unix timestamp of when this was last synced.
lastSyncData
string
Date object of when this was last synced.
deposits
array
Array of objects detailing the ethereal's deposit history.
Example Request
Response
Last updated