Skip to main content
GET
/
v1
/
instructions
List instructions
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.keystoneos.xyz/v1/instructions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "trade_reference": "<string>",
      "status": "<string>",
      "settlement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "template_slug": "<string>",
      "role": "<string>",
      "party": {},
      "legs": [
        {}
      ],
      "timeout_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.keystoneos.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Auth0 JWT access token. See Authentication for details.

Query Parameters

​
status
string | null

Filter by status (pending_match, matched, cancelled, expired).

​
limit
integer
default:50

Maximum results.

Required range: 1 <= x <= 200
​
offset
integer
default:0

Results to skip.

Required range: x >= 0

Response

Successful Response

​
items
InstructionRead · object[]
required
​
total
integer
required
​
limit
integer
required
​
offset
integer
required