GET /v1/entities
List entities
| Availability | Private Preview |
|---|---|
| Method and path | GET /v1/entities |
| API version | 1.0.0-private-preview |
| Base URL | https://api.torq.finance |
| Authentication | Anonymous discovery |
| Idempotency | Not declared by this operation. |
| Rate limits | Read x-ratelimit-* and x-request-id response headers. Do not hard-code a quota. |
Request examples
curl -X GET 'https://api.torq.finance/v1/entities' \ -H 'Accept: application/json'
This calls the docs preview and returns sample data shaped by the governed OpenAPI response. It never accepts credentials or changes protocol state.
Run the sample call to inspect a schema-shaped response without credentials or side effects.| Request body | None. |
|---|
Responses
| Status | Meaning | Schema |
|---|---|---|
200 | Successful response | EntityResourceCollection |
400 | Invalid request | TorqApiError |
401 | Authentication required | TorqApiError |
403 | Insufficient scope or authority | TorqApiError |
409 | State or idempotency conflict | TorqApiError |
429 | Rate limit exceeded | TorqApiError |
500 | Internal failure | TorqApiError |
200 response schema
EntityResourceCollection EntityResourceCollection
| Property | Type | Required | Description |
|---|---|---|---|
items | EntityResource[] | Yes | — |
pageInfo | PageInfo | Yes | — |
freshness | FreshnessEvidence | Yes | — |
Inspect nested properties
items EntityResource[] · required
items EntityResource
| Property | Type | Required | Description |
|---|---|---|---|
entityType | string | No | — |
entityId | string | No | — |
label | string | null | No | — |
status | string | null | No | — |
ownerAddress | string | null | No | — |
Inspect nested properties
entityType string · optional
entityId string · optional
label string | null · optional
nullable
status string | null · optional
nullable
ownerAddress string | null · optional
pattern: ^0x[a-fA-F0-9]{40}$ · nullable
pageInfo PageInfo · required
| Property | Type | Required | Description |
|---|---|---|---|
hasMore | boolean | Yes | — |
nextCursor | string | null | Yes | — |
Inspect nested properties
hasMore boolean · required
nextCursor string | null · required
nullable
freshness FreshnessEvidence · required
| Property | Type | Required | Description |
|---|---|---|---|
status | enum | Yes | — |
lagSeconds | integer | Yes | — |
blockNumber | string | null | No | — |
blockTimestamp | string | null (date-time) | No | — |
projectedAt | string | null (date-time) | No | — |
snapshotAt | string | null (date-time) | No | — |
reason | string | null | No | — |
Inspect nested properties
status enum · required
one of: current, healthy, stale, missing, blocked
lagSeconds integer · required
minimum: 0
blockNumber string | null · optional
nullable
blockTimestamp string | null (date-time) · optional
nullable
projectedAt string | null (date-time) · optional
nullable
snapshotAt string | null (date-time) · optional
nullable
reason string | null · optional
nullable
400, 401, 403, 409, 429, 500 response schema
TorqApiError TorqApiError
| Property | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
code | string | Yes | — |
message | string | Yes | — |
requestId | string | Yes | — |
retryable | boolean | Yes | — |
blockedReason | string | null | No | — |
docsUrl | string (uri) | No | — |
Inspect nested properties
ok boolean · required
code string · required
minimum length: 1 · maximum length: 200
message string · required
minimum length: 1 · maximum length: 200
requestId string · required
minimum length: 1 · maximum length: 200
retryable boolean · required
blockedReason string | null · optional
nullable
docsUrl string (uri) · optional
Related guides
- Authentication and scopes
- Errors, idempotency, and rate limits
- Canonical state and final completion
- SDK reference
For retry behavior and blocked-state handling, see Errors and rate limits.