Data API

Read the rows of any Simetrik resource from your own systems — filtered, sorted and paged — over a single HTTP endpoint.

The Data API is how your systems read Simetrik data programmatically. Point it at a resource — a source, a reconciliation output, a transformation — and it returns the rows as JSON, with the filtering, sorting and pagination you'd expect from a query interface.

There is one endpoint. Everything you can ask for is expressed in its query string:

GET /api/v1/resources/{resource_id}/data

It reads. It never writes, and it never changes what's in Simetrik.

Your first call

Get your API key

Simetrik issues it for your account, along with the base URL to call. The examples here call it $SIMETRIK_API_URL.

Find the resource id

It's the numeric id of the resource you want to read. If you use the CLI, simetrik resource list prints every resource in the workspace with its id.

Ask for the first ten rows

curl "$SIMETRIK_API_URL/api/v1/resources/58729/data?page=1&page_size=10" \
  -H "X-API-Key: $SIMETRIK_API_KEY" \
  -H "workspace_id: 886"

You get the rows and a summary of where you are in the result set:

{
  "data": [
    {"A.id": "TX-0001", "A.amount": 1500, "status": "RECONCILED"},
    {"A.id": "TX-0002", "A.amount": 2400, "status": "UNRECONCILED"}
  ],
  "meta": {
    "page": 1,
    "page_size": 10,
    "returned_count": 2,
    "total_count": 2,
    "total_pages": 1
  }
}

Where to go next

Authentication

The two headers every call needs, and what each failure means.

Reference

Every parameter, the filter operators, the response shape and each error.

Or use the CLI instead

If you're exploring rather than integrating, simetrik data query reads the same rows from your terminal, with a SQL-like filter expression and CSV output. It's the better tool for a look at the data; this API is the better tool for a job that runs on a schedule and feeds another system.

One practical difference: the CLI caps a page at 200 rows, this API at 10,000.