Skip to main content
GET
/
api
/
private
/
swaps
/
{id}
/
Get Swap
curl --request GET \
  --url https://app.digitalsurge.com.au/api/private/swaps/{id}/ \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "src_asset": "<string>",
  "dst_asset": "<string>",
  "bought_amount": "<string>",
  "sold_amount": "<string>",
  "src_fee": "<string>",
  "dst_fee": "<string>",
  "aud_value": "<string>",
  "req_get_amount": "<string>",
  "req_spend_amount": "<string>",
  "expected_price": "<string>"
}

Authorizations

​
Authorization
string
header
required

Personal API key, created in the Digital Surge app under Account Settings → API Keys. Send it with every request as Authorization: Bearer <your-api-key>.

Path Parameters

​
id
string
required

Response

200 - application/json

Read-only view of a swap, extending the create serializer with aud_value.

aud_value is null while the swap is processing and populated once it reaches a terminal state (processed/rejected). For AUD-involved trades the value is exact; for crypto-to-crypto it is the ticker-estimated AUD value at the time of finalization.

​
id
integer
required
read-only
​
status
enum<integer>
required
  • 5 - quote
  • 10 - pending
  • 12 - estimated
  • 15 - processing
  • 20 - error
  • 40 - rejected
  • 60 - processed
Available options:
5,
10,
12,
15,
20,
40,
60
​
src_asset
string
required
​
dst_asset
string
required
​
bought_amount
string<decimal> | null
required
read-only

Final amount bought by the customer

​
sold_amount
string<decimal> | null
required
read-only

Final amount sold by the customer

​
src_fee
string<decimal> | null
required
read-only
​
dst_fee
string<decimal> | null
required
read-only
​
aud_value
string<decimal> | null
required
read-only

For reference purposes only.

​
req_get_amount
string<decimal> | null

Net amount, after subtracting the fee

​
req_spend_amount
string<decimal> | null

Total amount, incl. the fee

​
expected_price
string<decimal> | null