The Tableland Validator API is organized around REST. You can leverage these APIs to read directly from tables and compose data across them, and make calls to learn information about the node itself. Keep in mind that a node listens to mainnet chains and testnet chains separately such that there are separate Base URLs for each respective environment.

Setup

There are no required prerequisites, but it may be helpful to become familiar with HTTPie and cURL since the examples provided use these. Also, jq is an optional tool to help pipe the output from the API calls to a more human readable, “pretty” format (e.g., curl <url> | jq).

Base URLs

The following base URLs are supported:

Testnet chains ⇒ https://testnets.tableland.network/api/v1
Mainnet chains ⇒ https://tableland.network/api/v1

Endpoints

The following endpoints are available at the Base URL gateways above:

/query ⇒ Write a SQL read query and get table data.
/receipt/{chainId}/{transactionHash} ⇒ Retrieve on-chain transaction information regarding a table create or write query.
/tables/{chainId}/{tableId} ⇒ Get table metadata and information.
/health ⇒ Check if the validator is up and running.
/version ⇒ Check version information about the validator daemon.

Definitions

transactionHash ⇒ Resultant on-chain transaction hash corresponding to a table’s creation or a write query.
chainId ⇒ Blockchain or L2 solution on which transactions are being sent; available chainId values can be found here.
tableId ⇒ The unique identifier assigned to the created table upon the contract minting the table as an ERC721 token.

Synopsis

This general API specification is used to automatically generate clients and backend services; it should be used as the primary source of truth for Validator APIs. This specification is a living document, and as such, may be updated over time. Proposals for the addition of API features and fixes may be submitted by the Tableland community over time. These proposals will be evaluated for technical feasibility, utility to the community, and longer-term sustainability.

In Tableland, Validators are the execution unit/actors of the protocol. They have the following responsibilities: