Skip to main content
GET
Get swap quote

Authorizations

Authorization
string
header
required

API key issued by a Hedgin administrator, in the form hv1_<id>_<secret>. <id> is 1 to 48 characters and <secret> is 32 to 128 characters, both from [A-Za-z0-9_-].

Query Parameters

vault
string
required

A vault this key may access. The server checks the allowlist and current on-chain authority before it reads. Base58 Solana public key. The server decodes it and rejects anything that is not 32 bytes.

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$
Example:

"So11111111111111111111111111111111111111112"

inputMint
string
required

Base58 Solana public key. The server decodes it and rejects anything that is not 32 bytes.

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$
Example:

"So11111111111111111111111111111111111111112"

outputMint
string
required

Must differ from inputMint. Base58 Solana public key. The server decodes it and rejects anything that is not 32 bytes.

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$
Example:

"So11111111111111111111111111111111111111112"

amount
string
required

Input amount in inputMint base units. Non-negative integer in token base units, as a decimal string. Must fit in u64 (at most 18446744073709551615). Never a JSON number.

Maximum string length: 20
Pattern: ^\d+$
Example:

"1000000"

slippageBps
integer
required

Integer from 1 to 10000. The quote uses the lower of this value and the protocol's maxSlippageBps.

Required range: 1 <= x <= 10000

Response

The vault address and the quote.

vault
string
required

Base58 Solana public key. The server decodes it and rejects anything that is not 32 bytes.

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$
Example:

"So11111111111111111111111111111111111111112"

data
object
required