Get account ledger

Reads the account’s ledger for a caller allowed to view the workspace’s wallets. A member session reads the venue live (source: live). An API key or OAuth client needs treasury_read and never starts a venue read: it gets the account’s last recorded observation (source: recorded), dated by observedAt, with stale true when it is over an hour old, or 409 LEDGER_NOT_OBSERVED when none is recorded yet, and 404 VENUE_ACCOUNT_NOT_FOUND for another workspace’s account. Positions and credit retain separate observation and provider times. Failed credit remains unavailable while readable positions are returned. No background polling. 409 LEDGER_UNSUPPORTED means the venue does not report a ledger; LEDGER_SETUP_MISSING means its connection needs setup; VENUE_ACCOUNT_LEDGER_PENDING means the account has not finished setup, so nothing is observed yet. 403 LEDGER_ACCOUNT_FORBIDDEN without permission to view wallets on this workspace’s account; foreign accounts refuse before provider I/O. 502 LEDGER_DATA_INVALID when the venue’s figures cannot be read as exact amounts; 503 LEDGER_READ_UNAVAILABLE or LEDGER_JOURNAL_UNAVAILABLE when the read cannot complete, with the last good read time when one is known. A failed read is never an empty ledger.

GET /api/v1/workspaces/{workspaceId}/venue-accounts/{venueAccountId}/ledger

Read the venue account's signed positions and credit line

cURL

curl --request GET \
  --url https://api.tetrafi.io/api/v1/workspaces/{workspaceId}/venue-accounts/{venueAccountId}/ledger \
  --header 'Authorization: Bearer <token>'

200

{
  "componentFreshness": [
    {
      "component": "<string>",
      "observedAt": "2023-11-07T05:31:56Z",
      "venueTime": {
        "state": "reported",
        "value": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "credit": {
    "available": "<string>",
    "limit": "<string>",
    "state": "reported",
    "used": "<string>",
    "currency": "<string>"
  },
  "debitPurpose": {
    "scope": "sharedAccount"
  },
  "observationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "observedAt": "2023-11-07T05:31:56Z",
  "positions": [
    {
      "amount": "<string>",
      "asset": "<string>",
      "venueTime": {
        "state": "reported",
        "value": "2023-11-07T05:31:56Z"
      },
      "available": "<string>",
      "locked": "<string>"
    }
  ],
  "settledBeforeVenueTime": {
    "fills": true,
    "withdrawals": true
  },
  "venueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "venueTime": {
    "state": "reported",
    "value": "2023-11-07T05:31:56Z"
  },
  "readAt": "2023-11-07T05:31:56Z",
  "reconciliation": {
    "ledger": {
      "coverage": {
        "journalState": {
          "state": "covered"
        },
        "notes": [
          {
            "cause": "<string>",
            "dispatchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "baselineObservationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "coveredFrom": "2023-11-07T05:31:56Z"
      },
      "observationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "positions": [
        {
          "asset": "<string>",
          "baselineAmount": {
            "amount": "<string>",
            "state": "reported"
          },
          "baselineState": "<string>",
          "lpAmount": {
            "amount": "<string>",
            "state": "reported"
          },
          "projected": "<string>",
          "projectedAmount": {
            "amount": "<string>",
            "state": "reported"
          },
          "projectedEntries": [
            {
              "amount": "<string>",
              "asset": "<string>",
              "effectiveAt": "2023-11-07T05:31:56Z",
              "entryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "entryIndex": 123,
              "entryKind": "<string>",
              "evidenceRef": "<string>",
              "recordedAt": "2023-11-07T05:31:56Z",
              "source": "<string>",
              "sourceRef": "<string>",
              "timeBasis": "provider",
              "venueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "workspaceId": "<string>",
              "feeDetail": "<unknown>",
              "providerFillRef": "<string>"
            }
          ],
          "reflectedEntries": [
            {
              "amount": "<string>",
              "asset": "<string>",
              "effectiveAt": "2023-11-07T05:31:56Z",
              "entryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "entryIndex": 123,
              "entryKind": "<string>",
              "evidenceRef": "<string>",
              "recordedAt": "2023-11-07T05:31:56Z",
              "source": "<string>",
              "sourceRef": "<string>",
              "timeBasis": "provider",
              "venueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "workspaceId": "<string>",
              "feeDetail": "<unknown>",
              "providerFillRef": "<string>"
            }
          ],
          "reflectedJournal": "<string>",
          "reflectionUncertain": [
            {
              "amount": "<string>",
              "asset": "<string>",
              "effectiveAt": "2023-11-07T05:31:56Z",
              "entryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "entryIndex": 123,
              "entryKind": "<string>",
              "evidenceRef": "<string>",
              "recordedAt": "2023-11-07T05:31:56Z",
              "source": "<string>",
              "sourceRef": "<string>",
              "timeBasis": "provider",
              "venueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "workspaceId": "<string>",
              "feeDetail": "<unknown>",
              "providerFillRef": "<string>"
            }
          ],
          "residualCategory": "<string>",
          "unexplained": {
            "amount": "<string>",
            "state": "reported"
          },
          "projectedRange": {
            "high": "<string>",
            "low": "<string>"
          },
          "projectionMessage": "<string>"
        }
      ],
      "venueAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "state": "available"
  },
  "source": "live",
  "stale": true
}

Authorizations

bearer_authapi_key

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Scopes

treasury_read · bearer_auth

treasury_read · api_key

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).

Path Parameters

workspaceId · string · required

Current company or broker workspace

venueAccountId · string<uuid> · required

Response

200

application/json

componentFreshness · object[] · required

Show child attributes

credit · object · required

New values may be added; treat unknown values as other.

Option 1

Option 2

Option 3

Show child attributes

debitPurpose · object · required

New values may be added; treat unknown values as other.

Option 1

Option 2

Show child attributes

observationId · string<uuid> · required

observedAt · string<date-time> · required

positions · object[] · required

Show child attributes

settledBeforeVenueTime · object · required

Show child attributes

venueAccountId · string<uuid> · required

venueTime · object · required

New values may be added; treat unknown values as other.

Option 1

Option 2

Show child attributes

readAt · string<date-time> · required

When this answer was composed.

reconciliation · object · required

New values may be added; treat unknown values as other.

Option 1

Option 2

Show child attributes

source · enum<string> · required

live: read from the venue for this request (a member session). recorded: the account's last recorded observation (an API key or OAuth client never starts a venue read); observedAt dates it and stale says whether it is over an hour old.

Available options: live, recorded

stale · boolean | null

Recorded reads only: the observation is older than an hour.