Get trade settlement

One trade’s settlement state. The taker perspective is the order’s settlement detail (required API-key scope: settlements_read; the caller must be allowed to view settlements). The maker perspective is the LP’s settlement pipeline for the order, a member-session read for a member allowed to view bilateral documents. Each perspective answers exactly what its own route answers.

GET /api/v1/workspaces/{workspaceId}/trades/{tradeId}/settlement

Get trade settlement

cURL

curl --request GET \
  --url https://api.tetrafi.io/api/v1/workspaces/{workspaceId}/trades/{tradeId}/settlement \
  --header 'Authorization: Bearer <token>'

200

{
  "lifecycle": [
    {
      "stage": "<string>",
      "status": "<string>",
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ],
  "lpResponse": {
    "solverName": "<string>",
    "fillTimeMs": 1,
    "quotePrice": "<string>",
    "slippageBps": 123
  },
  "orderId": "<string>",
  "transactions": {
    "fillTx": {
      "chainId": 1,
      "hash": "<string>"
    },
    "proofTx": {
      "chainId": 1,
      "hash": "<string>"
    },
    "sourceTx": {
      "chainId": 1,
      "hash": "<string>"
    }
  }
}

Authorizations

bearer_authapi_key

Authorization · string · header · required

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

Scopes

settlements_read · bearer_auth

settlements_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

Workspace ID

tradeId · string · required

The trade's tradeId (its order id)

Query Parameters

perspective · enum<string>

taker (default): the order's settlement lifecycle; maker: the LP's settlement-pipeline state (an LP member session) Which side of the trade the workspace was on.

Available options: taker, maker

venueId · string

perspective=maker: the LP's own venue; omitted reads every owned venue

Response

200

application/json

taker: lifecycle stages, transactions and LP response; maker: the pipeline stage, age, retries and transactions

One trade's settlement as the taker: its lifecycle stages, transactions and LP response. The maker perspective is read by a signed-in member only.

lifecycle · object[] · required

Show child attributes

lpResponse · object · required

LP/solver response metrics.

Show child attributes

orderId · string · required

transactions · object · required

Transaction hashes for source, fill, and proof transactions.

Show child attributes