Intents

Get completed intents

Lists intents that have filled, been cancelled or been rejected, for the caller’s organization. Live intents are served by the intents service at /v1/intents; this endpoint serves the record of finished ones. The record is kept for six years, and how much of it a caller may read is set by their plan: start is raised to that window when it reaches back past it, and omitting start reads from the window rather than from the beginning. The anthid-retention-days response header carries the window applied. Returns one row per action by default so an amended order shows what it was amended from; pass terminal_only=true for one row per intent.

GET

ledger

intents

history

Get completed intents

curl --request GET \
  --url https://api.anthid.com/v1/ledger/intents/history \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.anthid.com/v1/ledger/intents/history', 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.anthid.com/v1/ledger/intents/history",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.anthid.com/v1/ledger/intents/history"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.anthid.com/v1/ledger/intents/history")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "action_type": "CREATE",
      "created_at": "2023-11-07T05:31:56Z",
      "intent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order_side": "UNSPECIFIED",
      "order_type": "UNSPECIFIED",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "principal_id": "<string>",
      "principal_type": "API_KEY",
      "quantity": "<string>",
      "received_at": "2023-11-07T05:31:56Z",
      "request_id": "<string>",
      "route_strategy": "UNSPECIFIED",
      "seq": 123,
      "symbol": "<string>",
      "filled_quantity": "<string>",
      "terminal_at": "2023-11-07T05:31:56Z",
      "terminal_seq": 123,
      "terminal_status": "PENDING",
      "client_reference_id": "<string>",
      "idempotency_key": "<string>",
      "limit_price": "<string>",
      "source_ip": "<string>",
      "stop_price": "<string>",
      "time_in_force": "UNSPECIFIED",
      "external_order_id": "<string>",
      "principal_name": "<string>"
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

account_id

string<uuid>

Trading account ID. Omitted, the read covers every account in the organization.

environment

enum<string>

required

Required. Which environment the read covers. Resolved to the organization's accounts in that environment, including disabled and deleted ones, since the ledger stores no environment of its own. Rejected with 400 when it disagrees with the account named alongside it.

Available options:

paper,

live

intent_id

string<uuid>

One intent, by id. Returns its whole action chain.

symbol

string

Filter by symbol. Normalized to uppercase.

terminal_status

string

How the intent ended: FILLED, CANCELLED or REJECTED

start

string<date-time>

Inclusive range start, against the sort column when that is a clock and terminal_at otherwise

end

string<date-time>

Exclusive range end, bounding the same column as start

terminal_only

boolean

One row per intent instead of one per action

limit

integer<int32>

Maximum rows; defaults to 100 and is capped at 1000

Required range: x >= 0

sort_by

enum<string>

Sort field; defaults to terminal_at Sortable columns on completed intents.

Deliberately short. Every column here is either in the table's sort key or cheap to scan, and a sort offered over a six year table is a promise about cost as much as about ordering.

Available options:

terminal_at,

created_at,

received_at,

symbol

sort_direction

enum<string>

Sort direction; defaults to Desc

Available options:

Asc,

Desc

next_cursor

string

Opaque keyset cursor from a previous response. Only valid for the sort_by it was issued with.

Response

Completed intents retrieved

data

object[]

required

Show child attributes

next_cursor

string | null

Get completed intents

curl --request GET \
  --url https://api.anthid.com/v1/ledger/intents/history \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.anthid.com/v1/ledger/intents/history', 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.anthid.com/v1/ledger/intents/history",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.anthid.com/v1/ledger/intents/history"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.anthid.com/v1/ledger/intents/history")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "action_type": "CREATE",
      "created_at": "2023-11-07T05:31:56Z",
      "intent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order_side": "UNSPECIFIED",
      "order_type": "UNSPECIFIED",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "principal_id": "<string>",
      "principal_type": "API_KEY",
      "quantity": "<string>",
      "received_at": "2023-11-07T05:31:56Z",
      "request_id": "<string>",
      "route_strategy": "UNSPECIFIED",
      "seq": 123,
      "symbol": "<string>",
      "filled_quantity": "<string>",
      "terminal_at": "2023-11-07T05:31:56Z",
      "terminal_seq": 123,
      "terminal_status": "PENDING",
      "client_reference_id": "<string>",
      "idempotency_key": "<string>",
      "limit_price": "<string>",
      "source_ip": "<string>",
      "stop_price": "<string>",
      "time_in_force": "UNSPECIFIED",
      "external_order_id": "<string>",
      "principal_name": "<string>"
    }
  ],
  "next_cursor": "<string>"
}

Connections

Organizations

Controls

Accounts

Intents

Ledger

Stream

MCP

Get completed intents

Authorizations

Query Parameters

Response