v1

Get a gateway quote.

Checks the available liquidity and provides a quote.

get/v1/get-quote

Query parameters

srcChainstring required

Source chain

dstChainstring required

Destination chain

senderstring

Address sending the funds

recipientstring required

Address receiving the funds

srcTokenstring required

Source token address

dstTokenstring required

Destination token address

amountstring required

Amount to swap (in smallest unit, e.g., sats or wei)

gasRefillstring

Deprecated: gas refill is no longer supported. Supplying this field is rejected with an error. Removed in V3.

slippagestring required

Slippage tolerance (in basis points, e.g., 300 = 3%)

strategyTargetstring

Deprecated: custom strategies are no longer supported. Supplying this field is rejected with an error. Removed in V3.

strategyMessagestring

Deprecated: custom strategies are no longer supported. Supplying this field is rejected with an error. Removed in V3.

affiliateIdstring

Optional affiliate ID

Response

Get a quote

OR
OR

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

  • 162bab886181214See the full diff
    • removed the required property details/oneOf[GatewayErrorDetails]/oneOf[subschema #3 -> subschema #8]/min_required_sats from the response with the 400 status

      response-required-property-removed

    • removed the required property details/oneOf[GatewayErrorDetails]/oneOf[subschema #3 -> subschema #8]/sender from the response with the 400 status

      response-required-property-removed

    • added the new QUOTE_AMOUNT_TOO_LOW enum value to the code response property for the response status 400

      response-property-enum-value-added

    • the endpoint scheme security api_key was added to the API

      api-security-added

    • removed the INSUFFICIENT_FUNDS enum value from the code response property for the response status 400

      response-property-enum-value-removed

    • added the required property details/oneOf[GatewayErrorDetails]/oneOf[subschema #3 -> subschema #8]/actual to the response with the 400 status

      response-required-property-added

    • added the required property details/oneOf[GatewayErrorDetails]/oneOf[subschema #3 -> subschema #8]/minimum to the response with the 400 status

      response-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 400

      response-non-success-status-added

    • added the required property oneOf[subschema #1]/onramp/signedQuoteData to the response with the 200 status

      response-required-property-added

  • a6065adb7d74111See the full diff
    • added subschema #1 subschema #2 subschema #3 to the response body oneOf list for the response status 200

      response-body-one-of-added

    • deleted the query request parameter instantSwap

      request-parameter-removed

    • removed subschema #1 subschema #2 subschema #3 from the response body oneOf list for the response status 200

      response-body-one-of-removed

    • added subschema #1 subschema #2 subschema #3 to the response body oneOf list for the response status 200

      response-body-one-of-added

    • added the new optional query request parameter instantSwap

      new-optional-request-parameter

    • removed subschema #1 subschema #2 subschema #3 from the response body oneOf list for the response status 200

      response-body-one-of-removed

    • added the optional property oneOf[subschema #3]/layerZero/sender to the response with the 200 status

      response-optional-property-added

    • added the required property oneOf[subschema #3]/layerZero/recipient to the response with the 200 status

      response-required-property-added

  • 66520595571611See the full diff
    • added subschema #1 subschema #2 subschema #3 to the response body oneOf list for the response status 200

      response-body-one-of-added

    • removed subschema #1 subschema #2 subschema #3 from the response body oneOf list for the response status 200

      response-body-one-of-removed

  • 8b8f903ea7dd12See the full diff
    • added subschema #1 subschema #2 subschema #3 to the response body oneOf list for the response status 200

      response-body-one-of-added

    • the query request parameter sender became optional

      request-parameter-became-optional

    • removed subschema #1 subschema #2 subschema #3 from the response body oneOf list for the response status 200

      response-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