curl --request POST \
--url https://api.turnkey.com/public/v1/query/get_swap_status \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header "X-Stamp: <string> (see Authorizations)" \
--data '{
"organizationId": "<string>",
"swapRequestId": "<string>"
}'
import { Turnkey } from "@turnkey/sdk-server";
const turnkeyClient = new Turnkey({
apiBaseUrl: "https://api.turnkey.com",
apiPublicKey: process.env.API_PUBLIC_KEY!,
apiPrivateKey: process.env.API_PRIVATE_KEY!,
defaultOrganizationId: process.env.ORGANIZATION_ID!,
});
const response = await turnkeyClient.apiClient().getSwapStatus({
organizationId: "<string> (Unique identifier for a given Organization.)",
swapRequestId: "<string> (The swap_request_id returned by ExecuteSwap.)"
});
{
"status": "<string>",
"swapKind": "<string>",
"provider": "<string>",
"inputToken": "<string>",
"outputToken": "<string>",
"inputAmount": "<string>",
"originTxHash": "<string>",
"destinationTxHashes": [
"<string>"
],
"outputAmount": "<string>",
"refund": {
"asset": "<string>",
"amount": "<string>",
"txHash": "<string>"
},
"updatedAt": "<string>",
"error": {
"reason": "<string>",
"message": "<string>",
"originTxError": {
"message": "<string>",
"revertChain": [
{
"address": "<string>",
"errorType": "<string>",
"displayMessage": "<string>",
"unknown": {
"selector": "<string>",
"data": "<string>"
},
"native": {
"nativeType": "<string>",
"message": "<string>",
"panicCode": "<string>"
},
"custom": {
"errorName": "<string>",
"paramsJson": "<string>"
}
}
],
"solana": {
"source": "<string>",
"rpcCode": "<number>",
"rpcMessage": "<string>",
"transactionErrorJson": "<string>",
"logs": [
"<string>"
],
"unitsConsumed": "<string>",
"innerInstructionsJson": "<string>"
},
"eth": {
"revertChain": [
{
"address": "<string>",
"errorType": "<string>",
"displayMessage": "<string>",
"unknown": {
"selector": "<string>",
"data": "<string>"
},
"native": {
"nativeType": "<string>",
"message": "<string>",
"panicCode": "<string>"
},
"custom": {
"errorName": "<string>",
"paramsJson": "<string>"
}
}
]
}
},
"providerReason": "<string>"
},
"destinationAddress": "<string>",
"charges": {
"executionUsd": "<string>",
"turnkeyFeeUsd": "<string>",
"fixedRateAdjustmentUsd": "<string>"
}
}
Queries
Get Swap status
Poll the status of a swap by its swap_request_id. Covers same-chain and cross-chain swaps.
curl --request POST \
--url https://api.turnkey.com/public/v1/query/get_swap_status \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header "X-Stamp: <string> (see Authorizations)" \
--data '{
"organizationId": "<string>",
"swapRequestId": "<string>"
}'
import { Turnkey } from "@turnkey/sdk-server";
const turnkeyClient = new Turnkey({
apiBaseUrl: "https://api.turnkey.com",
apiPublicKey: process.env.API_PUBLIC_KEY!,
apiPrivateKey: process.env.API_PRIVATE_KEY!,
defaultOrganizationId: process.env.ORGANIZATION_ID!,
});
const response = await turnkeyClient.apiClient().getSwapStatus({
organizationId: "<string> (Unique identifier for a given Organization.)",
swapRequestId: "<string> (The swap_request_id returned by ExecuteSwap.)"
});
{
"status": "<string>",
"swapKind": "<string>",
"provider": "<string>",
"inputToken": "<string>",
"outputToken": "<string>",
"inputAmount": "<string>",
"originTxHash": "<string>",
"destinationTxHashes": [
"<string>"
],
"outputAmount": "<string>",
"refund": {
"asset": "<string>",
"amount": "<string>",
"txHash": "<string>"
},
"updatedAt": "<string>",
"error": {
"reason": "<string>",
"message": "<string>",
"originTxError": {
"message": "<string>",
"revertChain": [
{
"address": "<string>",
"errorType": "<string>",
"displayMessage": "<string>",
"unknown": {
"selector": "<string>",
"data": "<string>"
},
"native": {
"nativeType": "<string>",
"message": "<string>",
"panicCode": "<string>"
},
"custom": {
"errorName": "<string>",
"paramsJson": "<string>"
}
}
],
"solana": {
"source": "<string>",
"rpcCode": "<number>",
"rpcMessage": "<string>",
"transactionErrorJson": "<string>",
"logs": [
"<string>"
],
"unitsConsumed": "<string>",
"innerInstructionsJson": "<string>"
},
"eth": {
"revertChain": [
{
"address": "<string>",
"errorType": "<string>",
"displayMessage": "<string>",
"unknown": {
"selector": "<string>",
"data": "<string>"
},
"native": {
"nativeType": "<string>",
"message": "<string>",
"panicCode": "<string>"
},
"custom": {
"errorName": "<string>",
"paramsJson": "<string>"
}
}
]
}
},
"providerReason": "<string>"
},
"destinationAddress": "<string>",
"charges": {
"executionUsd": "<string>",
"turnkeyFeeUsd": "<string>",
"fixedRateAdjustmentUsd": "<string>"
}
}
A successful response returns the following fields:
Was this page helpful?