Search by name, SuiNS, address, digest, object ID, coin type or checkpoint.

API

Objects

Any object now or at a past version or time, its dynamic fields with decoded names and values, and its tree of children.

When to use it

  • Read the state of a pool, a vault or a config object.
  • See what an object looked like on a past date.
  • Walk a table or a bag through its dynamic fields.

Quickstart

Replace YOUR_API_KEY with your key from the developer portal, or drop the key header to use the keyless tier. See Quickstart.

1. Get an object

The current object with its type, owner, version and contents.

curl "https://api.tide.ad/v1/objects/0x0000000000000000000000000000000000000000000000000000000000000006" \
  -H "x-api-key: YOUR_API_KEY"

2. Get it at a past checkpoint

The same object as it was at a checkpoint or time.

curl "https://api.tide.ad/v1/objects/0x0000000000000000000000000000000000000000000000000000000000000006/at?checkpoint=341000000" \
  -H "x-api-key: YOUR_API_KEY"

3. List dynamic fields

Names and values come back decoded.

curl "https://api.tide.ad/v1/objects/0xe05dafb5133bcffb8d59f4e12465dc0e9faeaa05e3e342a08fe135800e3e4407/dynamic-fields?limit=5" \
  -H "x-api-key: YOUR_API_KEY"

4. List every version

Each version with the transaction that wrote it.

curl "https://api.tide.ad/v1/objects/0x0000000000000000000000000000000000000000000000000000000000000006/history?limit=5" \
  -H "x-api-key: YOUR_API_KEY"

API reference

MethodWhat it doesCredits
objects.getGET /v1/objects/:idOne object: type, owner, version and fields as they are now.1
objects.atGET /v1/objects/:id/atAn object as it was at a version, checkpoint or time, with its contents.5
objects.dynamicFieldsGET /v1/objects/:id/dynamic-fieldsThe dynamic fields of an object, with decoded names and values.2
objects.historyGET /v1/objects/:id/historyEvery version of an object since it was created, either direction.5
objects.treeGET /v1/objects/:id/treeEverything an object holds: dynamic fields, tables, wrapped structs and kiosk items.10

Full lists: Chain, Objects. Every method page has its parameters, credits and an example response.