Build Swap

post https://api-wallet-sandbox.venly.io/api/wallets/{id}/swaps

This endpoint returns the transaction detail that is needed to perform the actual swap, based on information obtained in the Get Exchange Rate endpoint. This endpoint will build a transaction for you, which afterward you or your user needs to execute. Each item in the response array needs to be taken, enriched with the relevant signing method and submitted against the endpoint: /api/transactions/execute

Path Params

string

required

This is the ID of the source wallet. (Wallet that holds tokens to swap)

Body Params

walletId

string

required

The wallet ID of the source wallet

destinationWalletId

string

required

The wallet ID of the destination wallet

fromSecretType

string

required

The blockchain of source wallet

toSecretType

string

required

The blockchain of the destination wallet

fromToken

string

Source token contract address

toToken

string

Destination token contract address

inputAmount

number

required

The amount of tokens to swap

outputAmount

number

required

The amount of tokens to recieve

orderType

string

required

The type of order. We only allow SELL and BUY.

exchange

string

required

The name of exchange to use for the swap

enableGasEstimate

boolean

Indicate to include gas estimate (response will contain value for the gas field). The response will include the gasLimit that needs to be used to execute the swap.

Responses

Language

Credentials

OAuth2

URL


xxxxxxxxxx
12
1
curl --request POST \
2
     --url https://api-wallet-sandbox.venly.io/api/wallets/id/swaps \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "fromSecretType": "AETERNITY",
8
  "toSecretType": "AETERNITY",
9
  "orderType": "SELL",
10
  "exchange": "AVAX_WAVAX"
11
}
12
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Swap transactions created successfully.

400When the request contains invalid input

401When the user is not authorized to access the resource

403When a user doesn't have proper security authority

404When a resource is not found

405When the HttpMethod is not supported

415Usually when the input is not a valid json

500When there's an unexpected error