Get a gateway quote.
Checks the available liquidity and provides a quote.
Query parameters
Source chain
Destination chain
Address sending the funds
Address receiving the funds
Source token address
Destination token address
Amount to swap (in smallest unit, e.g., sats or wei)
Deprecated: gas refill is no longer supported. Supplying this field is rejected with an error. Removed in V3.
Slippage tolerance (in basis points, e.g., 300 = 3%)
Deprecated: custom strategies are no longer supported. Supplying this field is rejected with an error. Removed in V3.
Deprecated: custom strategies are no longer supported. Supplying this field is rejected with an error. Removed in V3.
Optional affiliate ID
Response
Get a quote
Changes
Changed in 9 of the 19 revisions of this API.6215
- ○
endpoint deprecated
endpoint-deprecated
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ▲
removed the required property
details/oneOf[GatewayErrorDetails]/oneOf[subschema #3 -> subschema #8]/min_required_satsfrom the response with the400statusresponse-required-property-removed
- ▲
removed the required property
details/oneOf[GatewayErrorDetails]/oneOf[subschema #3 -> subschema #8]/senderfrom the response with the400statusresponse-required-property-removed
- ●
added the new
QUOTE_AMOUNT_TOO_LOWenum value to thecoderesponse property for the response status400response-property-enum-value-added
- ○
the endpoint scheme security
api_keywas added to the APIapi-security-added
- ○
removed the
INSUFFICIENT_FUNDSenum value from thecoderesponse property for the response status400response-property-enum-value-removed
- ○
added the required property
details/oneOf[GatewayErrorDetails]/oneOf[subschema #3 -> subschema #8]/actualto the response with the400statusresponse-required-property-added
- ○
added the required property
details/oneOf[GatewayErrorDetails]/oneOf[subschema #3 -> subschema #8]/minimumto the response with the400statusresponse-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ○
added the non-success response with the status
400response-non-success-status-added
- ○
- ○
added the required property
oneOf[subschema #1]/onramp/signedQuoteDatato the response with the200statusresponse-required-property-added
- ○
- ▲
added
subschema #1subschema #2subschema #3to the response bodyoneOflist for the response status200response-body-one-of-added
- ●
deleted the
queryrequest parameterinstantSwaprequest-parameter-removed
- ○
removed
subschema #1subschema #2subschema #3from the response bodyoneOflist for the response status200response-body-one-of-removed
- ▲
- ▲
added
subschema #1subschema #2subschema #3to the response bodyoneOflist for the response status200response-body-one-of-added
- ○
added the new optional
queryrequest parameterinstantSwapnew-optional-request-parameter
- ○
removed
subschema #1subschema #2subschema #3from the response bodyoneOflist for the response status200response-body-one-of-removed
- ▲
- ○
added the optional property
oneOf[subschema #3]/layerZero/senderto the response with the200statusresponse-optional-property-added
- ○
added the required property
oneOf[subschema #3]/layerZero/recipientto the response with the200statusresponse-required-property-added
- ○
- ▲
added
subschema #1subschema #2subschema #3to the response bodyoneOflist for the response status200response-body-one-of-added
- ○
removed
subschema #1subschema #2subschema #3from the response bodyoneOflist for the response status200response-body-one-of-removed
- ▲
- ▲
added
subschema #1subschema #2subschema #3to the response bodyoneOflist for the response status200response-body-one-of-added
- ○
the
queryrequest parametersenderbecame optionalrequest-parameter-became-optional
- ○
removed
subschema #1subschema #2subschema #3from the response bodyoneOflist for the response status200response-body-one-of-removed
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲