Intent

Get latest intent action

Returns the latest recorded action for an intent in the resolved organization. Pass trading_account_id to require that the intent belongs to that account; omitted, the intent is looked up across every account the organization owns. Service-account callers must provide x-organization-id and have intent:read; API-key callers need organization intent read permission; user callers need an organization admin, member, or read-only role. Non-service callers can only read their principal organization, and a supplied trading account must belong to the resolved organization.

GET

intents

{intent_id}

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

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

fetch('https://api.anthid.com/v1/intents/{intent_id}', 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/intents/{intent_id}",
  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/intents/{intent_id}"

	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/intents/{intent_id}")

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

{
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "intent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quantity": "<string>",
  "seq": 123,
  "symbol": "<string>",
  "client_reference_id": "<string>",
  "limit_price": "<string>",
  "stop_price": "<string>"
}

{
  "EncryptionError": "<string>"
}

{
  "EncryptionError": "<string>"
}

{
  "EncryptionError": "<string>"
}

{
  "EncryptionError": "<string>"
}

{
  "EncryptionError": "<string>"
}

{
  "EncryptionError": "<string>"
}

Authorizations

Authorization

string

header

required

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

Headers

x-organization-id

string<uuid> | null

Organization id required when reading with service-account credentials

Path Parameters

intent_id

string<uuid>

required

Intent id to fetch

Query Parameters

trading_account_id

string<uuid>

Optional trading account the intent must belong to. Omitted reads across the whole organization.

Response

Latest intent action retrieved

account_id

string<uuid>

required

action_type

enum<string>

required

Available options:

CREATE,

REPLACE,

CANCEL

created_at

string<date-time>

required

intent_id

string<uuid>

required

order_side

enum<string>

required

Available options:

UNSPECIFIED,

BUY,

SELL,

SELL_SHORT

order_type

enum<string>

required

Available options:

UNSPECIFIED,

LIMIT,

MARKET,

FILL_OR_KILL,

LIMIT_ON_OPEN,

LIMIT_ON_CLOSE,

MARKET_ON_OPEN,

MARKET_ON_CLOSE,

STOP,

STOP_LIMIT,

TRAILING_STOP

organization_id

string<uuid>

required

quantity

string

required

route_strategy

enum<string>

required

Available options:

UNSPECIFIED,

SMART,

AMEX,

ARCA,

BATS,

BATY,

EDGA,

EDGX,

NSDQ,

NYSE

seq

integer<int64>

required

symbol

string

required

client_reference_id

string | null

limit_price

null | string

stop_price

null | string

time_in_force

null | enum<string>

Available options:

UNSPECIFIED,

DAY,

IMMEDIATE_OR_CANCEL,

GOOD_TILL_CANCEL,

AT_OPEN,

AT_CLOSE,

FILL_OR_KILL,

EXT

List intent actionsReturns the append-only action history for an intent in the resolved organization, latest action first by default. Pass `sort_direction=asc` to replay the lineage in the order it was appended, and `trading_account_id` to require that the intent belongs to that account. If no actions exist for that intent, the response is `200` with an empty `data` array. Service-account callers must provide `x-organization-id` and have `intent:read`; API-key callers need organization intent read permission; user callers need an organization admin, member, or read-only role. Non-service callers can only read their principal organization, and a supplied trading account must belong to the resolved organization.

Get latest intent action

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

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

fetch('https://api.anthid.com/v1/intents/{intent_id}', 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/intents/{intent_id}",
  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/intents/{intent_id}"

	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/intents/{intent_id}")

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

{
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "intent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quantity": "<string>",
  "seq": 123,
  "symbol": "<string>",
  "client_reference_id": "<string>",
  "limit_price": "<string>",
  "stop_price": "<string>"
}

{
  "EncryptionError": "<string>"
}

{
  "EncryptionError": "<string>"
}

{
  "EncryptionError": "<string>"
}

{
  "EncryptionError": "<string>"
}

{
  "EncryptionError": "<string>"
}

{
  "EncryptionError": "<string>"
}

Connections

Organizations

Controls

Accounts

Intents

Ledger

Stream

Get latest intent action

Authorizations

Headers

Path Parameters

Query Parameters

Response