Docs
Canonical resources

GET /v1/funds/{resourceId}

Get a distressed recovery fund, current epoch, fees, readiness, and subscription terms

AvailabilityPrivate Preview
Method and pathGET /v1/funds/{resourceId}
API version1.0.0-private-preview
Base URLhttps://api.torq.finance
AuthenticationPublishableKey, SecretKey
IdempotencyNot declared by this operation.
Rate limitsRead x-ratelimit-* and x-request-id response headers. Do not hard-code a quota.

Authentication requirements

  • PublishableKey
  • SecretKey

Request examples

terminal
curl -X GET 'https://api.torq.finance/v1/funds/sample_resourceid' \
  -H 'Accept: application/json' \
  -H 'x-torq-publishable-key: $TORQ_PUBLISHABLE_KEY'
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 bodyNone.

Parameters

NameInRequiredType
resourceIdpathYesstring
fieldsqueryNostring[]

Responses

StatusMeaningSchema
200Successful responseFundResource
400Invalid requestTorqApiError
401Authentication requiredTorqApiError
403Insufficient scope or authorityTorqApiError
409State or idempotency conflictTorqApiError
429Rate limit exceededTorqApiError
500Internal failureTorqApiError

200 response schema

FundResource FundResource

PropertyTypeRequiredDescription
idstringNo
chainIdintegerNo
addressstringNo
namestringNo
statusstringNo
navAssetsstring | nullNo
navAsOfstring | null (date-time)No
quoteAssetAddressstring | nullNo
quoteAssetDecimalsinteger | nullNo
managerAddressstring | nullNo
managerNamestring | nullNo
assetManagerEntityIdstring | nullNo
fundReadinessApprovedbooleanNo
quoteAssetProfileApprovedbooleanNo
impairmentStatusstringNo
purchasesEnabledbooleanNo
shareTokenActivebooleanNo
subscriptionStatusCodeinteger | nullNo
defaultEligibilityStatusCodeinteger | nullNo
subscriptionStatusstringNo
investorEligibilityStatusstringNo
minSubscriptionAssetsstring | nullNo
maxSubscriptionAssetsstring | nullNo
shareTokenAddressstring | nullNo
sharePricestring | nullNo
totalSupplystring | nullNo
totalHoldingsinteger | nullNo
liquidHoldingsinteger | nullNo
restrictedHoldingsinteger | nullNo
carryRateBpsinteger | nullNo
performanceFeeBpsinteger | nullNo
preferredReturnBpsinteger | nullNo
effectiveEpochIdstring | nullNo
epochDurationSecondsstring | nullNo
currentEpochFundEpochResource | nullNo
epochsFundEpochResource[]No
holdingsFundHoldingResource[]No
freshnessFreshnessEvidenceNo
Inspect nested properties

id string · optional

chainId integer · optional

address string · optional

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

name string · optional

status string · optional

navAssets string | null · optional

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

navAsOf string | null (date-time) · optional

nullable

quoteAssetAddress string | null · optional

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

quoteAssetDecimals integer | null · optional

nullable

managerAddress string | null · optional

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

managerName string | null · optional

nullable

assetManagerEntityId string | null · optional

nullable

fundReadinessApproved boolean · optional

quoteAssetProfileApproved boolean · optional

impairmentStatus string · optional

purchasesEnabled boolean · optional

shareTokenActive boolean · optional

subscriptionStatusCode integer | null · optional

nullable

defaultEligibilityStatusCode integer | null · optional

nullable

subscriptionStatus string · optional

investorEligibilityStatus string · optional

minSubscriptionAssets string | null · optional

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

maxSubscriptionAssets string | null · optional

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

shareTokenAddress string | null · optional

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

sharePrice string | null · optional

nullable

totalSupply string | null · optional

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

totalHoldings integer | null · optional

nullable

liquidHoldings integer | null · optional

nullable

restrictedHoldings integer | null · optional

nullable

carryRateBps integer | null · optional

nullable

performanceFeeBps integer | null · optional

nullable

preferredReturnBps integer | null · optional

nullable

effectiveEpochId string | null · optional

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

epochDurationSeconds string | null · optional

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

currentEpoch FundEpochResource | null · optional

Inspect alternative shapes

variant 1 FundEpochResource

PropertyTypeRequiredDescription
idstringNo
fundAddressstringNo
epochIdstring | nullNo
statusstringNo
quoteAssetAddressstring | nullNo
quoteAssetDecimalsinteger | nullNo
openedAtstring | nullNo
scheduledCloseAtstring | nullNo
closedAtstring | nullNo
postCloseFundingDeadlinestring | nullNo
depositedQuoteAmountstring | nullNo
withdrawnQuoteAmountstring | nullNo
activeScaleRaystring | nullNo
activeReservationIdstring | nullNo
fundedSidePocketCountinteger | nullNo
blockNumberstring | nullNo
Inspect nested properties

id string · optional

fundAddress string · optional

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

epochId string | null · optional

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

status string · optional

quoteAssetAddress string | null · optional

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

quoteAssetDecimals integer | null · optional

nullable

openedAt string | null · optional

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

scheduledCloseAt string | null · optional

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

closedAt string | null · optional

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

postCloseFundingDeadline string | null · optional

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

depositedQuoteAmount string | null · optional

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

withdrawnQuoteAmount string | null · optional

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

activeScaleRay string | null · optional

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

activeReservationId string | null · optional

nullable

fundedSidePocketCount integer | null · optional

nullable

blockNumber string | null · optional

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

variant 2 null

epochs FundEpochResource[] · optional

items FundEpochResource

PropertyTypeRequiredDescription
idstringNo
fundAddressstringNo
epochIdstring | nullNo
statusstringNo
quoteAssetAddressstring | nullNo
quoteAssetDecimalsinteger | nullNo
openedAtstring | nullNo
scheduledCloseAtstring | nullNo
closedAtstring | nullNo
postCloseFundingDeadlinestring | nullNo
depositedQuoteAmountstring | nullNo
withdrawnQuoteAmountstring | nullNo
activeScaleRaystring | nullNo
activeReservationIdstring | nullNo
fundedSidePocketCountinteger | nullNo
blockNumberstring | nullNo
Inspect nested properties

id string · optional

fundAddress string · optional

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

epochId string | null · optional

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

status string · optional

quoteAssetAddress string | null · optional

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

quoteAssetDecimals integer | null · optional

nullable

openedAt string | null · optional

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

scheduledCloseAt string | null · optional

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

closedAt string | null · optional

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

postCloseFundingDeadline string | null · optional

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

depositedQuoteAmount string | null · optional

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

withdrawnQuoteAmount string | null · optional

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

activeScaleRay string | null · optional

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

activeReservationId string | null · optional

nullable

fundedSidePocketCount integer | null · optional

nullable

blockNumber string | null · optional

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

holdings FundHoldingResource[] · optional

items FundHoldingResource

PropertyTypeRequiredDescription
idstringNo
positionIdstringNo
fundAddressstringNo
assetLanestringNo
holdingStatusstringNo
transferPriceAssetsstring | nullNo
acquiredAtstring | null (date-time)No
disposedAtstring | null (date-time)No
marketAddressstring | nullNo
borrowerAddressstring | nullNo
claimableAssetsstring | nullNo
recoveryValueAssetsstring | nullNo
Inspect nested properties

id string · optional

positionId string · optional

fundAddress string · optional

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

assetLane string · optional

holdingStatus string · optional

transferPriceAssets string | null · optional

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

acquiredAt string | null (date-time) · optional

nullable

disposedAt string | null (date-time) · optional

nullable

marketAddress string | null · optional

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

borrowerAddress string | null · optional

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

claimableAssets string | null · optional

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

recoveryValueAssets string | null · optional

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

freshness FreshnessEvidence · optional

PropertyTypeRequiredDescription
statusenumYes
lagSecondsintegerYes
blockNumberstring | nullNo
blockTimestampstring | null (date-time)No
projectedAtstring | null (date-time)No
snapshotAtstring | null (date-time)No
reasonstring | nullNo
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

PropertyTypeRequiredDescription
okbooleanYes
codestringYes
messagestringYes
requestIdstringYes
retryablebooleanYes
blockedReasonstring | nullNo
docsUrlstring (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.