Skip to main content
GET
`GET /api/v1/assets`: the Assets, variants and deployments the workspace can trade.

Authorizations

X-API-Key
string
header
required

Send the API key in X-API-Key.

Request signing. A key with signing enabled (POST /api/v1/workspaces/{workspaceId}/users/me/api-keys/{keyId}/signing, which returns the signing secret once) must also sign every request:

  • X-Timestamp: the current Unix time in seconds, within 300 seconds of the server clock.
  • X-Signature: lower-case hex HMAC-SHA256 of the canonical string, keyed with the signing secret's 32 bytes (the secret is 64 hex characters; decode it first).

The canonical string is four lines joined by \n, with no trailing newline: the X-Timestamp value, the upper-case method, the path with its query exactly as sent (/api/v1/orders?limit=1), and the lower-case hex SHA-256 of the exact body bytes (the SHA-256 of an empty body when there is none).

A write's signature (POST, PUT, PATCH, DELETE) is accepted once: sending the same signed write again is refused, so a retry signs again. A read (GET, HEAD) changes nothing, so an identical signed read inside the window is admitted again and polling needs no nonce.

A signing refusal is a 401 AUTH_REQUIRED whose details.reason names the cause: SIGNATURE_REQUIRED (a header is missing), SIGNATURE_INVALID (a malformed header or a wrong signature), TIMESTAMP_OUT_OF_RANGE or SIGNATURE_REPLAYED.

Headers

X-Workspace-Id
string<uuid>

The workspace the request acts in. An API key bound to a workspace implies it: omit the header, or send that same id (another id answers 403 WORKSPACE_SCOPE_MISMATCH). A member session must send it (400 MISSING_WORKSPACE without it).

Query Parameters

limit
integer<int32>

Assets per page, 1 to 200. With only a cursor, the page size that cursor was issued with.

Required range: x >= 0
cursor
string

The previous page's nextCursor. A cursor is valid while the listing it was issued for is unchanged; after a change it answers 409 CURSOR_STALE, and the walk starts again.

Response

Workspace-eligible Assets with variants and CAIP-2 deployments. API keys require the prices_read scope.

Assets available to the current workspace, with registry provenance and listing completeness.

assets
object[]
required
eligibility
object
required

Whether the listing is complete for the workspace.

registry
object
required

The registry snapshot a response was built from.

nextCursor
string | null

On a paged request (limit or cursor), the cursor of the next page; absent on the last page and on an unpaged request.