Subgraphs API

Subgraph name, as deployed (the name in its definition).

Table name, one of the keys of the definition's schema. GET /v1/subgraphs/{name} lists them.

Case-insensitive contains match across every column marked search: true in the definition, ORed. 400 on a table with no searchable column.

Column filters, one query param each, ANDed. Any table column or system column (_id, _block_height, _tx_id, _created_at) works. col=value is equality; col.op=value applies an operator, one of gte, lte, gt, lt, neq, like, in, notIn. like is a case-insensitive contains match. in and notIn take a comma-separated list. An unknown column is 400 INVALID_COLUMN; an unknown operator, or the misplaced form col=op.value, is 400 VALIDATION_ERROR. Bare limit, offset, sort, order, fields and search are 400: control params take a leading underscore.

Page size, 1 to 1000. A non-integer, 0, a negative, or anything over 1000 is 400, not clamped.

The previous page's next_cursor, verbatim. Opaque: its shape depends on _sort, so never build one. A cursor issued under one _sort/_order is 400 under another.

One column to sort by. A comma list and jsonb columns are 400. Omit to page by _id.

Direction of the _sort column, or of _id without _sort. Anything but asc or desc is 400.

Comma-separated columns to return. An unknown name is 400 INVALID_COLUMN. The cursor still works: _id and the _sort column are read for it and dropped from rows you did not ask them for.

Subgraph name, as deployed (the name in its definition).

Table name, one of the keys of the definition's schema. GET /v1/subgraphs/{name} lists them.

exact runs COUNT(*). estimate reads the planner's row estimate instead, with no table scan, but only when there are no filters and no _search; otherwise it counts exactly. The estimate can be -1 before the table's first ANALYZE.

Case-insensitive contains match across every column marked search: true in the definition, ORed. 400 on a table with no searchable column.

Column filters, one query param each, ANDed. Any table column or system column (_id, _block_height, _tx_id, _created_at) works. col=value is equality; col.op=value applies an operator, one of gte, lte, gt, lt, neq, like, in, notIn. like is a case-insensitive contains match. in and notIn take a comma-separated list. An unknown column is 400 INVALID_COLUMN; an unknown operator, or the misplaced form col=op.value, is 400 VALIDATION_ERROR. Bare limit, offset, sort, order, fields and search are 400: control params take a leading underscore.

Subgraph name, as deployed (the name in its definition).

Table name, one of the keys of the definition's schema. GET /v1/subgraphs/{name} lists them.

Include count. Any value but false turns it on. count is also returned when no other aggregate is asked for.

Comma-separated columns to count distinct values of. Any column.

Comma-separated columns to sum. Numeric only: uint or int columns, or _block_height; others are 400 NON_NUMERIC_COLUMN.

Comma-separated numeric columns to take the minimum of.

Comma-separated numeric columns to take the maximum of.

Case-insensitive contains match across every column marked search: true in the definition, ORed. 400 on a table with no searchable column.

Column filters, one query param each, ANDed. Any table column or system column (_id, _block_height, _tx_id, _created_at) works. col=value is equality; col.op=value applies an operator, one of gte, lte, gt, lt, neq, like, in, notIn. like is a case-insensitive contains match. in and notIn take a comma-separated list. An unknown column is 400 INVALID_COLUMN; an unknown operator, or the misplaced form col=op.value, is 400 VALIDATION_ERROR. Bare limit, offset, sort, order, fields and search are 400: control params take a leading underscore.

Subgraph name, as deployed (the name in its definition).

Table name, one of the keys of the definition's schema. GET /v1/subgraphs/{name} lists them.

Block height to replay from: rows with _block_height at or above it, then the live tail. A value that is not a number is ignored. With nothing at or above it yet, the stream tails live.

Case-insensitive contains match across every column marked search: true in the definition, ORed. 400 on a table with no searchable column.

Column filters, one query param each, ANDed. Any table column or system column (_id, _block_height, _tx_id, _created_at) works. col=value is equality; col.op=value applies an operator, one of gte, lte, gt, lt, neq, like, in, notIn. like is a case-insensitive contains match. in and notIn take a comma-separated list. An unknown column is 400 INVALID_COLUMN; an unknown operator, or the misplaced form col=op.value, is 400 VALIDATION_ERROR. Bare limit, offset, sort, order, fields and search are 400: control params take a leading underscore.

Subgraph name, as deployed (the name in its definition).

Table name, one of the keys of the definition's schema. GET /v1/subgraphs/{name} lists them.

The row's _id.

Subgraph name, as deployed (the name in its definition).

Subgraph name, as deployed (the name in its definition).

Base URL written into the document's endpoints and examples. Defaults to this request's origin, honoring X-Forwarded-Proto.

Subgraph name, as deployed (the name in its definition).

Base URL written into the document's endpoints and examples. Defaults to this request's origin, honoring X-Forwarded-Proto.

Subgraph name, as deployed (the name in its definition).

Base URL written into the document's endpoints and examples. Defaults to this request's origin, honoring X-Forwarded-Proto.

Also return each subgraph's hourly health for this many hours, the same shape as the health read. 1 to 168.

Subgraph name. Lowercase letters, digits and hyphens. Deploying an existing name updates it.

Event sources keyed by name, as read from the handler module. At least one.

Table definitions keyed by table name.

The bundled handler module. 1 MB max.

Overrides the definition's startBlock for this deploy and forces a reindex from it. Refused past the chain tip (START_BLOCK_PAST_TIP).

One line on what the subgraph indexes.

The unbundled TypeScript source, kept so secondlayer subgraphs source can return it. 1 MB max.

Validate and return the DDL plan without writing anything.

The subgraph module's TypeScript source, with defineSubgraph as the default export.

Subgraph name, as deployed. Lowercase letters, digits and hyphens.

Subgraph name, as deployed. Lowercase letters, digits and hyphens.

Accepted and logged. The delete proceeds after the 30-second wait either way.

Subgraph name, as deployed. Lowercase letters, digits and hyphens.

Subgraph name, as deployed. Lowercase letters, digits and hyphens.

First block height to re-run, inclusive.

Last block height to re-run, inclusive.

Subgraph name, as deployed. Lowercase letters, digits and hyphens.

Subgraph name, as deployed. Lowercase letters, digits and hyphens.

Subgraph name, as deployed. Lowercase letters, digits and hyphens.

Operation id (UUID) from a deploy, reindex or backfill response, or from the operations list.

Subgraph name, as deployed. Lowercase letters, digits and hyphens.

Gaps to skip. Default 0.

true or all include resolved gaps with the open ones. Omit for open gaps only.

Page size, 1 to 1000. Default 50.

Subgraph name, as deployed. Lowercase letters, digits and hyphens.

Hours to return, 1 to 168. Default 24.

Subgraph name, as deployed. Lowercase letters, digits and hyphens.

Groups to return, 1 to 50. Default 20.

Subgraph name, as deployed. Lowercase letters, digits and hyphens.

Page size, 1 to 100. Default 50.

Every subgraph you can read. Not paginated.

The chain tip this list was read against.

Fixed reminder of the row-read shape and cursor rules, for agents reading the directory cold.

Subgraph name.

The definition's description, if it has one.

Deployed version.

Indexing state: active (following the chain), reindexing, paused, or error.

First deploy.

Contracts the definition reads from: each source's contractId, and the contract half of each assetIdentifier.

Block indexing starts from. 0 means genesis.

Each table by name.

Generated docs for this subgraph.

Always 3.1.0.

Title, the subgraph's version, and its description.

The server param, or this request's origin.

A list path and a count path per table.

A <table>Row schema per table.

Subgraph name.

Deployed version.

sha256 of the definition's name, schema and sources. Changes only when they do.

sha256 over the schema hash, bundled handler, startBlock, network and runtime. Absent for subgraphs deployed before pins existed.

When this document was generated.

The definition's sources, as written.

Table names.

Subgraph name.

Deployed version.

The definition's description. Absent without one.

sha256 of the definition's name, schema and sources.

sha256 over the schema hash, bundled handler, startBlock, network and runtime.

When this schema was generated.

The server param, or this request's origin.

The definition's sources, as written.

Per table: absolute endpoints, exact rowCount, columns including system columns, accepted query params and filters, and example requests.

The page, in _id order or _sort order.

Pass back as cursor to resume after this page. Set on every page that returned rows, including a short last page; null only on an empty page, which means you are caught up. To tail, keep the last cursor you got: cursor = next_cursor ?? cursor. Without _sort it is the last row's _id; with _sort it is an opaque token.

Rows matching the filters, or the planner's estimate for an unfiltered _count=estimate.

Rows matching the filters. Present with _count, or when no other aggregate was asked for.

Distinct values per _countDistinct column.

Sum per _sum column. "0" over no rows.

Minimum per _min column. null over no rows.

Maximum per _max column. null over no rows.

Subgraph name.

Deployed version.

Processor state.

Highest block processed.

Events handled since deploy.

Approximate rows across tables, from table statistics.

Handler errors since deploy.

Table names.

Progress denominator: the chain tip, or the reindex target while reindexing.

The instance's chain tip.

Height this sync or reindex is walking toward.

Fraction of blocks processed, 0 to 1.

Blocks left to targetBlock.

reindex while a reindex walk runs.

Open gaps.

gaps_detected when any gap is open.

Most recent processing error.

When it happened.

Last registry update.

First deploy.

Hourly health, present only when the list is requested with health.

Always true.

Name from the definition.

Description from the definition, if set.

Event sources by name.

Table definitions by name.

The bundled handler module.

The code you sent, echoed back.

Size of handlerCode in bytes.

Subgraph name.

Deployed version.

Hash of the table schema. Changes when the schema does.

Hash of everything that shapes rows: schema hash, bundled handler, startBlock, network, runtime. Null for subgraphs deployed before pins existed.

Derived verification level. Null for subgraphs deployed before levels were derived.

Processor state.

Highest block processed.

From the definition, when set.

Event sources by name, from the definition.

The stored definition: name, description, startBlock, sources, schema.

totalProcessed and totalErrors since deploy, errorRate, the last error and when, emptyMapping (events matched but every table is empty), and violationCount (print violations kept).

By table name: read endpoint, columns (with the system columns _id, _block_height, _tx_id, _created_at), exact rowCount, an example query, and indexes and uniqueKeys when declared.

First deploy.

Last registry update.

One-line summary.

First block. For a reindex, the subgraph's start block.

Last block. For a reindex, the string "chain tip": it runs to whatever the tip is when it gets there.

Poll /api/subgraphs/{name}/operations/{operation_id}.

Always queued.

Operation id.

Subgraph it runs on.

reindex drops and rebuilds; backfill re-runs a range in place.

queued until a processor claims it. completed, failed and cancelled are final.

light for contract-scoped sources, heavy for broad ones. The processor limits how many heavy operations run at once.

First block. null on a reindex queued from /reindex, which starts at the subgraph's start block.

Last block. null means the chain tip.

Blocks covered. Set when the operation finishes.

Backfills only: last committed block. A requeued backfill resumes after it.

Events expected, computed at enqueue for contract-scoped sources.

Events processed so far.

Fraction done, 0 to 1, from events when estimated, else blocks. null before any progress is reported.

Queued only: approximate 1-based position. Show it as ~N.

Why it failed.

When a processor claimed it.

When it reached a final status.

When it was queued.

Last change.

First missing block.

Last missing block, inclusive.

Blocks in the range.

block_missing: the block was not in the index. processing_error: a handler threw.

When it was recorded.

When a later walk covered it. null while open.

One bucket per hour, oldest first.

Handler errors across the newest 24 hours.

Violation id.

Source whose prints schema refused it.

Block of the event.

Transaction of the event.

Which field was missing or had the wrong type.

The decoded print, as topic and data.

When it was skipped.