Skip to main content
GET
/
v1
/
quotes
/
indicative
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
});

const indicative = await client.quotes.indicative.retrieve({
  source_currency: 'EUR',
  target_currency: 'EUR',
});

console.log(indicative.fee);
{
  "source_amount": "<string>",
  "source_currency": "EUR",
  "target_amount": "<string>",
  "target_currency": "EUR",
  "rate": "<string>",
  "venue": "<string>",
  "fee": {
    "amount": "<string>",
    "currency": "EUR"
  },
  "quoted_at": "2023-11-07T05:31:56Z"
}

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

source_currency
enum<string>
required

Source currency code.

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

Target currency code.

Available options:
EUR,
GBP,
USD,
USDC
source_amount
string

Source amount as a string decimal. Defaults to 1 unit if omitted.

Pattern: ^\d+(\.\d+)?$

Response

200 - application/json

The indicative quote

source_amount
string
required

Source amount as a string decimal.

source_currency
enum<string>
required

Source currency code.

Available options:
EUR,
GBP,
USD,
USDC
target_amount
string
required

Target amount as a string decimal.

target_currency
enum<string>
required

Target currency code.

Available options:
EUR,
GBP,
USD,
USDC
rate
string
required

Conversion rate applied.

venue
string
required

Venue the quote was fetched from.

fee
object
required

Conversion fee, or null if no fee applies.

quoted_at
string<date-time>
required

ISO 8601 UTC timestamp when the quote was fetched.