GET /v1/vaults/{resourceId}/liquidity
Get portfolio liquidity, duration, and exit terms
| Availability | Private Preview |
|---|---|
| Method and path | GET /v1/vaults/{resourceId}/liquidity |
| 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/vaults/sample_resourceid/liquidity' \ -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. |
|---|
Parameters
| Name | In | Required | Type |
|---|---|---|---|
resourceId | path | Yes | string |
Responses
| Status | Meaning | Schema |
|---|---|---|
200 | Successful response | VaultLiquidityResource |
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
VaultLiquidityResource VaultLiquidityResource
| Property | Type | Required | Description |
|---|---|---|---|
vaultId | string | No | — |
vaultAddress | string | No | — |
idleAssets | string | null | No | — |
totalAllocatedAssets | string | null | No | — |
immediatelyAvailableAssets | string | null | No | — |
liquidityBufferBps | integer | null | No | — |
baseAssetLockupPeriod | string | null | No | — |
portfolioLockupStatus | string | null | No | — |
longestKnownLockupPeriod | string | null | No | — |
attachedMarketCount | integer | null | No | — |
exposedMarketCount | integer | null | No | — |
unverifiedMarketCount | integer | null | No | — |
exitTermKind | string | null | No | — |
noticeSeconds | string | null | No | — |
intervalSeconds | string | null | No | — |
maturityTimestamp | string | null (date-time) | No | — |
tighteningLocked | boolean | null | No | — |
stressCoverageStatus | string | null | No | — |
durationCompatible | boolean | null | No | — |
blockedReason | string | null | No | — |
marketLiquidity | object[] | No | — |
Inspect nested properties
vaultId string · optional
vaultAddress string · optional
pattern: ^0x[a-fA-F0-9]{40}$
idleAssets string | null · optional
pattern: ^[0-9]+$ · nullable
totalAllocatedAssets string | null · optional
pattern: ^[0-9]+$ · nullable
immediatelyAvailableAssets string | null · optional
pattern: ^[0-9]+$ · nullable
liquidityBufferBps integer | null · optional
nullable
baseAssetLockupPeriod string | null · optional
nullable
portfolioLockupStatus string | null · optional
nullable
longestKnownLockupPeriod string | null · optional
nullable
attachedMarketCount integer | null · optional
nullable
exposedMarketCount integer | null · optional
nullable
unverifiedMarketCount integer | null · optional
nullable
exitTermKind string | null · optional
nullable
noticeSeconds string | null · optional
pattern: ^[0-9]+$ · nullable
intervalSeconds string | null · optional
pattern: ^[0-9]+$ · nullable
maturityTimestamp string | null (date-time) · optional
nullable
tighteningLocked boolean | null · optional
nullable
stressCoverageStatus string | null · optional
nullable
durationCompatible boolean | null · optional
nullable
blockedReason string | null · optional
nullable
marketLiquidity object[] · optional
items object
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.