Skip to content

GET /v1/vaults/{resourceId}/allocations

Availability
Private Preview
Method and path
GET /v1/vaults/{resourceId}/allocations
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

terminal
curl -X GET 'https://api.torq.finance/v1/vaults/sample_resourceid/allocations' \
  -H 'Accept: application/json'
Run a safe sample

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.

Parameters

resourceId
path
Yes
string

Responses

200
Successful response
VaultAllocationResourceCollection
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

VaultAllocationResourceCollection VaultAllocationResourceCollection

items
VaultAllocationResource[]
Yes
—
pageInfo
PageInfo
Yes
—
freshness
FreshnessEvidence
Yes
—
Inspect nested properties

items VaultAllocationResource[] · required

items VaultAllocationResource

vaultId
string
No
—
vaultAddress
string
No
—
marketId
string
No
—
marketAddress
string
No
—
listed
boolean
No
—
approved
boolean
No
—
allocationEnabled
boolean
No
—
capAssets
string | null
No
—
allocatedAssets
string | null
No
—
allocationBps
integer | null
No
—
Inspect nested properties

vaultId string · optional

vaultAddress string · optional

pattern: ^0x[a-fA-F0-9]{40}$

marketId string · optional

marketAddress string · optional

pattern: ^0x[a-fA-F0-9]{40}$

listed boolean · optional

approved boolean · optional

allocationEnabled boolean · optional

capAssets string | null · optional

pattern: ^[0-9]+$ · nullable

allocatedAssets string | null · optional

pattern: ^[0-9]+$ · nullable

allocationBps integer | null · optional

nullable

availableMarketLiquidity string | null · optional

pattern: ^[0-9]+$ · nullable

marketUtilizationWad string | null · optional

pattern: ^[0-9]+$ · nullable

marketBorrowRateAprBps integer | null · optional

nullable

marketLendingApyBps integer | null · optional

nullable

liquidityProfile string | null · optional

nullable

blockNumber string | null · optional

pattern: ^[0-9]+$ · nullable

pageInfo PageInfo · required

hasMore
boolean
Yes
—
nextCursor
string | null
Yes
—
Inspect nested properties

hasMore boolean · required

nextCursor string | null · required

nullable

freshness FreshnessEvidence · required

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

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

For retry behavior and blocked-state handling, see Errors and rate limits.