swap.v1.SwapService

GetSwap

GetSwap returns one of the caller's Swaps by swap_id or idempotency key. Errors: - INVALID_ARGUMENT: malformed selector. - NOT_FOUND: SWAP_NOT_FOUND. - PERMISSION_DENIED: SWAP_NOT_PERMITTED. - UNAVAILABLE: SERVICE_UNAVAILABLE; retry later. - UNAUTHENTICATED: missing or invalid credentials.

Method

POST

Path

swap.v1.SwapService/GetSwap

Service

swap.v1.SwapService

Visibility

Authentication required

Authentication

Session token or API key

MFA Requirement

Not required

POST

swap.v1.SwapService/GetSwap

Request

Testnet

curl --request POST \ \
  --url 'https://api.testnet.polyester.com/swap.v1.SwapService/GetSwap' \
  --header 'Content-Type: application/json' \
  --header 'Connect-Protocol-Version: 1' \
  --data '{
  "swapId": "1"
}'

Responses

{
  "swap": {
    "amountE18": {
      "hi": "1",
      "lo": "1"
    },
    "createdAt": "2025-01-01T00:00:00Z",
    "destinationAssetId": 100,
    "executedAmountE18": {
      "hi": "1",
      "lo": "1"
    },
    "feeE18": {
      "hi": "1",
      "lo": "1"
    },
    "idempotencyKey": "idem_01J5EXAMPLE0000000000000",
    "isTerminal": false,
    "minAmountOutE18": {
      "hi": "1",
      "lo": "1"
    },
    "orders": [
      {
        "feeE18": {
          "hi": "1",
          "lo": "1"
        },
        "leg": 1,
        "limitPriceTicks": "61000250000000",
        "orderId": "9876543210123",
        "receivedE18": {
          "hi": "1",
          "lo": "1"
        },
        "side": "BUY",
        "spentE18": {
          "hi": "1",
          "lo": "1"
        },
        "status": "PLACING",
        "symbolId": 1
      }
    ],
    "reason": "INSUFFICIENT_BALANCE",
    "receivedAmountE18": {
      "hi": "1",
      "lo": "1"
    },
    "sourceAssetId": 100,
    "status": "EXECUTING",
    "subaccountId": "6789012345678",
    "swapId": "1",
    "unspentAmountE18": {
      "hi": "1",
      "lo": "1"
    }
  }
}

Request

swap.v1.GetSwapRequest

Response

swap.v1.GetSwapResponse

swapId string (fixed64) required one of > 0

Swap ID.

idempotencyKey string required one of /^[A-Za…,128}$/

Idempotency key the Swap was created with.

one-of

16 fields

swapId string (fixed64)

Swap ID.

idempotencyKey string

Idempotency key the Swap was created with.

subaccountId string (fixed64)

Sub-account public ID funding the Swap; 0 for the root account.

sourceAssetId integer (int32)

Asset spent.

destinationAssetId integer (int32)

Asset received.

2 fields

status enum

Current status.

EXECUTING COMPLETED PARTIALLY_COMPLETED FAILED RECONCILING

reason enum

Why the Swap did not trade its whole amount; set with PARTIALLY_COMPLETED and FAILED.

INSUFFICIENT_BALANCE PRICE_PROTECTION MARKET_UNAVAILABLE ORDER_SIZE_OUT_OF_RANGE RATE_LIMITED ORDER_REJECTED EXPIRED MINIMUM_NOT_MET MAX_ORDER_QUANTITY

isTerminal boolean

True once the status is final: COMPLETED, PARTIALLY_COMPLETED or FAILED.

2 fields

9 fields

createdAt string (date-time)

When the Swap was created.

Possible errors: 5

Key	HTTP status	Connect code	Error	When
unauthenticated	401	unauthenticated	Unauthenticated	Authentication required.
permission-denied	403	permission_denied	Permission Denied	Permission denied.
invalid-argument	400	invalid_argument	Invalid Argument	Invalid argument.
not-found	404	not_found	Not Found	Not found.
unavailable	503	unavailable	Unavailable	Service unavailable.

POST

swap.v1.SwapService/GetSwap

Request

Testnet

curl --request POST \ \
  --url 'https://api.testnet.polyester.com/swap.v1.SwapService/GetSwap' \
  --header 'Content-Type: application/json' \
  --header 'Connect-Protocol-Version: 1' \
  --data '{
  "swapId": "1"
}'

Responses

{
  "swap": {
    "amountE18": {
      "hi": "1",
      "lo": "1"
    },
    "createdAt": "2025-01-01T00:00:00Z",
    "destinationAssetId": 100,
    "executedAmountE18": {
      "hi": "1",
      "lo": "1"
    },
    "feeE18": {
      "hi": "1",
      "lo": "1"
    },
    "idempotencyKey": "idem_01J5EXAMPLE0000000000000",
    "isTerminal": false,
    "minAmountOutE18": {
      "hi": "1",
      "lo": "1"
    },
    "orders": [
      {
        "feeE18": {
          "hi": "1",
          "lo": "1"
        },
        "leg": 1,
        "limitPriceTicks": "61000250000000",
        "orderId": "9876543210123",
        "receivedE18": {
          "hi": "1",
          "lo": "1"
        },
        "side": "BUY",
        "spentE18": {
          "hi": "1",
          "lo": "1"
        },
        "status": "PLACING",
        "symbolId": 1
      }
    ],
    "reason": "INSUFFICIENT_BALANCE",
    "receivedAmountE18": {
      "hi": "1",
      "lo": "1"
    },
    "sourceAssetId": 100,
    "status": "EXECUTING",
    "subaccountId": "6789012345678",
    "swapId": "1",
    "unspentAmountE18": {
      "hi": "1",
      "lo": "1"
    }
  }
}