API Reference

GraphQL

Coming soon: ask for exactly the fields you need across tables in a single request. Not yet available. The REST API ships today.

Coming soon. Not yet available

GraphQL is planned but has not shipped yet. The examples below describe the design we are building toward, not a live endpoint. Use the REST API today. It is fully available now.

Why GraphQL

Reach for GraphQL when you want a few columns from wide tables, or related tables in one round trip. There are no mutations to learn: the API is read only, so you write queries and subscriptions and nothing else.

  • Request the three columns you need from a table with forty, with no overfetching.
  • Traverse related tables in a single request instead of stitching REST calls.
  • Every dataset publishes a typed schema you can introspect and generate types from.

Example Query and Response

Point your client at the dataset, then select exactly the fields you want:

query.graphqlgraphql
query RecentTransactions {
  dataset(id: "retail-pos") {
    transactions(first: 100, after: $cursor) {
      txn_id
      total
      ts
    }
  }
}
response.jsonjson
{
  "data": {
    "dataset": {
      "transactions": [
        { "txn_id": "7d1c…3a", "total": 86.90, "ts": "2026-06-21T17:42:00Z" },
        { "txn_id": "8e2d…5b", "total": 129.99, "ts": "2026-06-21T17:43:11Z" }
      ]
    }
  }
}

Core Types

TypeKey FieldsDescription
Datasetid, name, industry, version, tablesA purchased dataset and its metadata
Tablename, columns, rowCountA table within a dataset
Recordfields (typed per table schema)A single row, typed to the schema
Versionsemver, date, notesAn immutable dataset version

Once available, the endpoint will live at https://www.datlyne.com/graphql and will use the same Bearer token as the REST API.