Trade by ID

curl --request GET \
  --url https://api.tetrafi.io/api/v1/workspaces/{id}/trades/{orderId} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.tetrafi.io/api/v1/workspaces/{id}/trades/{orderId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tetrafi.io/api/v1/workspaces/{id}/trades/{orderId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.tetrafi.io/api/v1/workspaces/{id}/trades/{orderId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.tetrafi.io/api/v1/workspaces/{id}/trades/{orderId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "trade": {},
  "settlement": {},
  "lp": {},
  "orderKind": "<string>",
  "substatus": "<string>",
  "substatusMessage": "<string>",
  "legs": [
    {}
  ],
  "member": {
    "userId": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "role": "<string>",
    "kycStatus": "<string>",
    "joinedAt": "2023-11-07T05:31:56Z"
  },
  "compliance": {},
  "snapshotCompliance": {},
  "travelRuleTransmission": {},
  "complianceProofs": {},
  "intent": {},
  "fees": {}
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

workspaces

{id}

trades

{orderId}

Trade by ID

curl --request GET \
  --url https://api.tetrafi.io/api/v1/workspaces/{id}/trades/{orderId} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.tetrafi.io/api/v1/workspaces/{id}/trades/{orderId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tetrafi.io/api/v1/workspaces/{id}/trades/{orderId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.tetrafi.io/api/v1/workspaces/{id}/trades/{orderId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.tetrafi.io/api/v1/workspaces/{id}/trades/{orderId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "trade": {},
  "settlement": {},
  "lp": {},
  "orderKind": "<string>",
  "substatus": "<string>",
  "substatusMessage": "<string>",
  "legs": [
    {}
  ],
  "member": {
    "userId": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "role": "<string>",
    "kycStatus": "<string>",
    "joinedAt": "2023-11-07T05:31:56Z"
  },
  "compliance": {},
  "snapshotCompliance": {},
  "travelRuleTransmission": {},
  "complianceProofs": {},
  "intent": {},
  "fees": {}
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Workspace API key (tfk_test_/tfk_live_); results are scoped to the key's workspace.

Path Parameters

string

required

Workspace whose trades are returned - results are scoped to it

orderId

string

required

Order id from the trades list - trades are keyed by order id, not transaction hash

Response

Successful Response

Full trade dossier keyed by order id. The settlement section carries the on-chain transaction hashes.

trade

Trade · object

required

Section A: trade details - the list-item fields plus fill time and slippage tolerance

settlement

Settlement · object

required

Section B: on-chain settlement - per-stage transaction references (submit/fill/proof/finalise and a generic transactions list), including the settlement transaction hashes

Lp · object

required

Section C: LP info

orderKind

string | null

Canonical route-aware order kind - omitted for non-route orders

substatus

string | null

Finer-grained state within the coarse status

substatusMessage

string | null

Human-readable elaboration of substatus

legs

Legs · object[] | null

Per-leg execution for multi-leg route orders; omitted for single-leg orders

member

MemberAttribution · object | null

Member identity attached to a trade - present for admin/owner callers only.

Show child attributes

compliance

Compliance · object | null

Compliance summary - admin/owner callers only

snapshotCompliance

Snapshotcompliance · object | null

Per-order compliance snapshot captured at creation - admin/owner callers only

travelRuleTransmission

Travelruletransmission · object | null

Latest Travel Rule transmission record - admin/owner callers only

complianceProofs

Complianceproofs · object | null

Cryptographic and provenance proofs - admin/owner callers only

intent

Intent · object | null

ERC-7683 intent envelope captured at submission - admin/owner callers only

fees

Fees · object

Fee breakdown: gas, protocol fee, solver fee, relayer tips - omitted when the order predates fee capture

Introduction

Core Concepts

RFQ API

TetraFi propAMM (RFS)

Router API

Price API

Trade History API

Trade by ID

Authorizations

Path Parameters

Response