Skip to main content
GET
/
v1
/
conversions
JavaScript
import Augustus from '@augustusbank/typescript-sdk';

const client = new Augustus({
  apiKey: process.env['AUGUSTUS_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const conversionListResponse of client.conversions.list()) {
  console.log(conversionListResponse.id);
}
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "conversion",
      "status": "pending",
      "source_amount": "<string>",
      "source_currency": "EUR",
      "target_currency": "EUR",
      "source_account_id": "<string>",
      "target_account_id": "<string>",
      "failure": {
        "message": "<string>"
      },
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.augustus.com/llms.txt

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

Authorizations

​
Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Query Parameters

​
limit
integer
default:10

Number of results per page (1-100). Defaults to 10.

Required range: 1 < x < 100
​
cursor
string

Opaque cursor from a previous next_cursor.

​
status
enum<string>

Filter by conversion status.

Available options:
pending,
completed,
failed
​
source_currency
enum<string>

Filter by source currency code.

Available options:
EUR,
GBP,
USD,
USDC
​
target_currency
enum<string>

Filter by target currency code.

Available options:
EUR,
GBP,
USD,
USDC

Response

200 - application/json

List of conversions

​
data
object[]
required
​
has_more
boolean
required
​
next_cursor
string | null
required