Swyftx API

swyftx swyftx
Help

Apiary Powered Documentation

Sign in with Apiary account.

Swyftx API

Introduction

Backend API for Swyftx.

The base route is https://api.swyftx.com.au

For demo mode, use https://api.demo.swyftx.com.au

Important Information

This API is in Beta. It may change without notice. This documentation was last updated for v1.242.1. You can use the info endpoint to know which version of the API you are using.

It supports all machine-to-machine compatible functionality that is available through our provided UIs including web and mobile

Authentication Overview

How to make an authenticated API Call

A JSON Web Token (JWT) needs to be included in the Authorization header for secured requests to the API.

  • Authorization: Bearer <token>
    • Replace <token> with your JWT

The JWT will contain the permissions granted to it by the API Key. Each endpoint found in this document will list its required permissions. See Scopes for all scopes

Additionally, a User-Agent header is required on most requests.

How to obtain a JWT

  1. Create an API key (aka refresh token) from the API Keys section of your Swyftx Profile

  2. Send a request to Refresh Access Token using the API Key to receive back a JWT

  3. Use the JWT in the Authorization header for authenticated requests

See the Authentication section for more details

Pagination

On endpoints that accept pagination, the following can be applied to page through results

Add to the query string of the request ?limit={resultsPerPage}&page={pageNumber}

  • limit (number, optional) - Number of entries you would like returned

  • page (number, optional) - Which page to return (one based indexing, so page=1 is the first page)

Demo Mode

Note that demo mode may have limitations or differences compared to the production environment, including endpoint support, behaviour, uptime, performance, and data accuracy.

Demo mode allows developers to test and integrate with the API without making actual transactions or affecting real user data. It provides a sandbox environment where you can simulate various API calls and responses.

To use demo mode, simply change the base URL to https://api.demo.swyftx.com.au

These are the endpoints available in demo mode:

Migrating a demo mode integration to live trading

Note that demo mode may have limitations or differences compared to the production environment, including endpoint support, behaviour, uptime, performance, and data accuracy.

Live validation testing is strongly recommended before migrating a demo mode integration to live trading. Consider trialing initially with a small amount of funds (to manage the risk exposure) in the live account to ensure that your integration works as expected.

Once you understand the differences between demo mode and live trading, you can change the base URL to https://api.swyftx.com.au.

Reference

Authentication


Creating an API Key

Creating a key is done in the profile page on Swyftx. When creating a key, a label is required, be sure to name it something descriptive. Additionally, keys can have unique permissions, a list of which can be found here. Just check the boxes of the permissions you would like the key to have.

Also, be sure to save this API Key as once the screen is closed, we cannot retrieve it in any way and you will have to create a new one.

Generating an Access Token

You can generate the JWT for authentication with the Refresh Access Token endpoint. An API key can be used to generate any number of access tokens with the same permissions it was originally created with.

An API Key can not be used in place of an access token. A request to refresh does not require authentication, so if your current token expires you can quickly generate a new one. Access tokens last for a week before expiring.

Revoking a Key

Keys do not expire, but can be manually revoked through your profile in case it gets misplace or misused. Revoking a key can be done through the profile on Swyftx, or by any key with the app.api.revoke permission.

You can revoke a key using the Revoke Key endpoint. This will also revoke all access tokens currently active created with the key.

The revoke all endpoint will revoke all keys including itself. Do not use this unless absolutely sure.

Refresh Access Token

Generates a new JWT using an API Key.

Refresh

Request
object
  • apiKey
    Your API Key
    string, required
    7r4hTa2Yb...
Response
object
  • accessToken
    The JWT string
    string
    eyJhbGciOiJSUzI1N...
  • scope
    The scope of the API Key
    string
    app.account.read ...
Request
object
  • apiKey
    Your API Key
    string, required
    7r4hTa2Yb...
Response
object
  • error
    object, required

Logout

This will invalidate the current access token, a new one can be generated with your API Key.

Logout

Response
object
  • success
    When JWT invalidated successfully
    string, required
    true
Response
object
  • error
    object, required

Get Scope

Get Scope

Response
object
  • app.account.read
    object
  • app.funds.withdraw
    object
  • app.orders.delete
    object
Response
object
  • error
    object, required

Get Keys

Get Keys

Response
array
  • object
Response
object
  • error
    object, required

Revoke Key

Revoke Key

Request
object
  • keyId
    Id for key to be revoked
    string, required
    dcr_7mkRWn...
Response
object
  • status
    Status of request
    string
    API Key Revoked

Revoke All Keys

Revoke All Keys

Response
object
  • status
    Status of request
    string
    API Keys Revoked
Response
object
  • error
    object, required

Account


Profile

Get Profile

An Object with the user information

Response
object
Response
object
  • error
    object, required

Update Phone Number

Updates the phone number stored against the account. Sends two SMS OTPs, one to the old phone number, and one to the new phone number.

Request
object
  • phone
    string, required
    +6199999999
  • oldOTP
    string
    123456
  • newOTP
    string
    123456
Response
object
  • success
    boolean, required
  • oldOTP
    object, required
  • newOTP
    object, required
Request
object
  • phone
    string, required
    +6199999999
  • oldOTP
    string
    123456
  • newOTP
    string
    123456
Response
object
  • error
    object, required

Account Settings

Account Settings

Can adjust account settings such as favourite assets, SMS recovery, etc. When making changes, only include the changes you would like in the request.

Request
object
  • data
    object, required
Response
object
  • profile
    object
Request
object
  • data
    object, required
Response
object
  • error
    object, required

Verification

An Object with all user's verification information e.g: email, phone, id

Get Verification Info

Response
object
  • verification
    object
Response
object
  • error
    object, required

Verification

Saves GreenID verification info

Save Verification Info

Request
object
  • verification
    object, required
Request
object
  • verification
    object, required
Response
object
  • error
    object, required

Email Verification

Start Email Verification

Call to get sent a link via email to verify access to email account

Response
object
  • success
    True if check was successful
    boolean, required
    true
  • emailVerified
    True if verified
    boolean, required
    true
  • msg
    Guidance message
    string, required
    Your email is verified
Response
object
  • error
    object, required

Check Email Verification Status

Call once link clicked to check verification status

Response
object
  • success
    True if check was successful
    boolean, required
    true
  • emailVerified
    True if verified
    boolean, required
    true
  • msg
    Guidance message
    string, required
    Your email is verified
Response
object
  • error
    object, required

Phone Verification

Check Phone Verification Status

Call first to get sent SMS to phone number provided on startup to obtain token

URI Parameters
token
Response
object
  • success
    True if check was successful
    boolean, required
    true
  • phoneVerified
    True if verified
    boolean, required
    true
  • msg
    Guidance message
    string, required
    Your email is verified
Response
object
  • error
    object, required

Start Phone Verification

Call once sms received with token to verify access to phone

Response
object
  • success
    True if check was successful
    boolean, required
    true
  • phoneVerified
    True if verified
    boolean, required
    true
  • msg
    Guidance message
    string, required
    Your email is verified
Response
object
  • error
    object, required

Affiliation

Get's a users affiliation statistics and link

Get Affiliation Info

URI Parameters
forceRefreshForce endpoint to refresh on request
Response
object
  • referral_link
    Affiliation link for sharing
    string, required
    https://swyftx.com.au/?ref=XXXXXXXXXXX
  • referred_users
    Number of users referred to Swyftx
    number, required
    1
  • outstandingBalance
    Approximate amount due in next affiliate payout currently. Updates every three days.
    number, required
    123.34

Balance

An Object with all user's verification information e.g: email, phone, id

Get Account Balances

Response
array
  • object
Response
object
  • error
    object, required

Currency

Updates the default currency for the user

Set Currency

Request
object
  • profile
    object
Response
object
Request
object
  • profile
    object
Response
object
  • error
    object, required

Statistics

Shows statistics for the account and its usage. All value shown (except orders) are approximations given fluctuating exchange rates.

Statistics

Response
object
  • orders
    How many orders have been placed
    number
    491
  • traded

    Total value traded (in AUD)

    number
    20614.3484
  • deposited

    Total deposits made (in AUD)

    number
    5420.37
  • withdrawn

    Total withdrawals made (in AUD)

    number
    9400.58
Response
object
  • error
    object, required

Progress

Shows the completion status of particular milestones for the account.

Progress

Response
object
  • signUp
    Sign Up status
    boolean
    true
  • verified
    Has account verified
    boolean
    true
  • deposit
    Has made a deposit
    boolean
    true
  • trade
    Has initiated a trade
    boolean
    false
  • refer
    Has become an affiliate
    boolean
    false
  • completed
    Has completed all milestones
    boolean
    false
Response
object
  • error
    object, required

General Order Fees

Shows the fee that would be applied to an order, excluding any asset-specific fees

General Fees

Response
object
  • generalOrderFee
    The fee in decimal form
    string, required
    0.006
Response
object
  • error
    object, required

Order Fees

Shows the fee that would be applied to an order for the given assets/direction

Order Fees

URI Parameters
primary
secondary
direction
Response
object
  • orderFee
    The fee in decimal form
    string, required
    0.006
Response
object
  • error
    object, required
Response
object
  • error
    object, required

Promotions

Shows the active promotions for the account.

Promotions

Response
object
  • desc
    Description of the promotion
    string
    50% off fees first week
  • ref
    Promotion reference Id
    string
    bonusfee50
  • expiry
    The promotion expiry account verified
    number
    1593525600000
Response
object
  • error
    object, required

Tax Report

Returns a Tax report for the period.

Get Tax Report

URI Parameters
fromStart date for tax report in ms
offsetOptional timezone offset in ms. Negative numbers allowed.
toEnd date for tax report in ms
type

Report output format. Either csv, json or pdf

Response
object
  • cryptoStatement
    array
  • fiatStatement
    array
  • openingStatements
    object
  • closingStatements
    object

Transaction Report

Returns a Transaction report for the period.

Get Transaction Report

URI Parameters
fromStart date for transaction report in ms
offsetOptional timezone offset in ms. Negative numbers allowed.
toEnd date for transaction report in ms
type

Report output format. Either csv or pdf

Response
object
  • cryptoStatement
    array
  • fiatStatement
    array
  • openingStatements
    object
  • closingStatements
    object

Addresses


Endpoints to get/create/set new or current addresses for crypto and fiat withdrawal and deposit

Deposit

Get active addresses

The Get Active Addresses v2 endpoint supersedes the functionality of this endpoint for crypto addresses. In the future the v2 endpoint will also replace the fiat functionality of this endpoint.

URI Parameters
assetCode

Asset code. See Get Market Assets code for all asset codes

variantIdPayment method required for AUD
Response
object
  • address
    array
Response
object
  • error
    object, required
Response
object
  • error
    object, required

Get active addresses v2

Currently only supports crypto addresses. For fiat addresses see Get Active Addresses v2.

URI Parameters
assetId

Asset ID. See Get Market Assets id for all asset ids

networkIdNetwork ID for crypto assets
Response
object
  • address
    array
Response
object
  • error
    object, required
Response
object
  • error
    object, required

Create new address

URI Parameters
assetCode

Asset code. See Get Market Assets code for all market codes

variantIdDeposit method
Request
object
Response
object
  • address
    array
Request
object
Response
object
  • error
    object, required

Withdraw

Get saved addresses

URI Parameters
assetCode

Asset code. See Get Market Assets code for all market codes

Response
object
  • address
    array
Response
object
  • error
    object, required

Save new address

Request
object
  • address
    object
Response
object
  • address
    array
Request
object
  • address
    object
Response
object
  • error
    object, required

Delete Withdrawal Address

Remove address

URI Parameters
addressIdThe address id to delete
Response
object
  • error
    object, required

Verify Withdrawal Address

Use token obtained from emails to verify withdrawal

Verify Withdrawal Address

URI Parameters
tokenToken as given in email

Verify BSB

Verify BSB

URI Parameters
bsbBSB for bank
Response
object
  • durationMs
    Response time
    number
    5
  • status
    Response status
    string
    Ok
  • statusDescription
    Response status description
    string
    Operation completed successfully
  • address
    Address
    string
    The Bendigo Centre
  • bankCode
    Bank Code
    string
    BBL
  • bsb
    BSB
    string
    633-000
  • city
    City
    string
    Bendigo
  • closed
    Operational status
    boolean
    false
  • postCode
    Postcode
    string
    3550
  • state
    State
    string
    VIC
Response
object
  • error
    object, required

Check For Deposit

Check For Deposit

URI Parameters
assetCode

Must be ETH or an ERC-20 Asset

addressIdAddress to be checked
Response
object
  • error
    object, required

Alerts


View Price Alerts

Retrieve a detailed list of all price alerts filtered on updated time and asset pairs, for the user

Get Price Alerts

URI Parameters
primary

Asset ID. See Get Markets id for all market ids

secondary

Asset ID. See Get Markets id for all market ids

limitLimit number of records to return
from
to
statusThe status of the price alert
Response
array
  • object

Add Price Alerts

Creates a price alert for {secondary}:{primary} to send an alert at {trigger} price (in units of {secondary}/{primary}) e.g. Alert when BTC/USD drops below 10000 USD

Create Price Alert

URI Parameters
primary

Asset ID of a Primary Asset. See Get Markets id for all market ids

secondary

Asset ID. See Get Markets id for all market ids

Request
object
  • price

    The price (of the {primary} asset) at which the alert will trigger, e.g. 1000USD

    number, required
    1000

Cancel Price Alerts

Delete a price alert for the user

Delete Price Alert

Request
object
  • priceAlertUuid
    UUID of the price alert
    string, required
    pra_G2Z7pPmKBhERjSywDQZG1z

Charts v2 - DEPRECATED


The charts v2 endpoint is identical to the existing endpoint and will be sunset in the near future. For the most up to date endpoint information please refer to Charts.

Bar Charts

An Array of Objects which contain pricing ticks in standard OCHLVT format for bar charts

Get Bar Chart

URI Parameters
baseAsset

Asset code. See Get Market Assets code for all market codes

secondaryAsset

Asset code. See Get Market Assets code for all market codes

resolutionThe time span that the candles will cover
side

Side ask or bid

timeStart
timeEnd
limit

Number of candles to retrieve, limit 10000

Response
array
  • object

Latest Bars

Returns the latest bar for assets given. Assets given must be in Array following the correct format.

Get Latest Bars

URI Parameters
baseAsset

Asset code. See Get Market Assets code for all market codes

secondaryAsset

Asset code. See Get Market Assets code for all market codes

side

Side ask or bid

resolutionThe time span that the candles will cover
Response
array
  • object

Settings

Get Chart Settings

Response
object
  • supports_search
    boolean
    false
  • supports_group_request
    boolean
    false
  • supports_marks
    boolean
    false
  • exchanges
    array
  • symbols_types
    array
  • supported_resolutions
    enum[string, fixed]

Resolve Symbol

Resolve Symbol

URI Parameters
baseAsset

Asset code. See Get Market Assets code for all market codes

secondaryAsset

Asset code. See Get Market Assets code for all market codes

Response
object
  • name
    string
    BTCUSD
  • description
    string
    Bitcoin / US Dollars
  • type
    string
    bitcoin
  • session
    string
    24x7
  • exchange
    string
    SWYFTX
  • listed_exchange
    string
    SWYFTX
  • timezone
    string
    Australia/Brisbane
  • minmov
    number
    1
  • pricescale
    number
    100
  • minmive2
    number
    0
  • has_intraday
    boolean
    true
  • supported_resolutions
    enum[string, fixed]
  • data_status
    string
    streaming

Charts


Charts Data

This API provides charts data in the form of bars or "candles" for current, historical and in-progress data.

Historical data is provided by our Digital Asset Data friends at Kaiko.

Note that getLatestBar and getBars share a 300 request per minute rate limit

Bar Charts

An Array of Objects which contain pricing ticks in standard OCHLVT format for bar charts

Get Bar Chart

URI Parameters
baseAsset

Asset code. See Get Market Assets code for all market codes

secondaryAsset

Asset code. See Get Market Assets code for all market codes

resolutionThe time span that the candles will cover
side

Side ask or bid

timeStart
timeEnd
limit

Number of candles to retrieve, maximum limit 20000

Response
array
  • object

Latest Bar

Returns the latest in-progress bar for the assets given.

Get Latest Bar

URI Parameters
baseAsset

Asset code. See Get Market Assets code for all market codes

secondaryAsset

Asset code. See Get Market Assets code for all market codes

side

Side ask or bid

resolutionThe time span that the candle will cover
Response
array
  • object

Settings

The settings required for charting consumers such as Tradingview.

Get Chart Settings

Response
object
  • supports_search
    boolean
    false
  • supports_group_request
    boolean
    false
  • supports_marks
    boolean
    false
  • exchanges
    array
  • symbols_types
    array
  • supported_resolutions
    enum[string, fixed]

Resolve Symbol

Serves detailed information for an asset pair.

Resolve Symbol

URI Parameters
baseAsset

Asset code. See Get Market Assets code for all market codes

secondaryAsset

Asset code. See Get Market Assets code for all market codes

Response
object
  • name
    string
    BTCUSD
  • description
    string
    Bitcoin / US Dollars
  • type
    string
    bitcoin
  • session
    string
    24x7
  • exchange
    string
    SWYFTX
  • listed_exchange
    string
    SWYFTX
  • timezone
    string
    Australia/Brisbane
  • minmov
    number
    1
  • pricescale
    number
    100
  • minmive2
    number
    0
  • has_intraday
    boolean
    true
  • supported_resolutions
    enum[string, fixed]
  • data_status
    string
    streaming

Compare


Compare

Use this endpoint to compare apples to apples. See rates and spreads for other exchanges in Australia.

Get Comparison

URI Parameters
exchange
Response
object

Earn


Info

Get Earn information related to your account

Get Earn Information

Response
object
  • optedIn
    Whether your account is opted into the Earn feature
    boolean, required
    true
  • offerings
    array
  • rewards
    array

Offerings

Get current Earn offerings

Get Earn Offerings

Response
array
  • object

OptIn

Opt your account into the Earn feature

Opt Into Earn Feature

Expected Rewards

Get your expected rewards at the next Earn pyout

Get Expected Rewards

URI Parameters
offerId

Asset ID. See Get Market Assets id for all market ids

Response
object
  • rewards
    array

Deposit

Deposit into your Earn wallet

Deposit Into Earn Wallet

Request
object
  • offerId
    Offer unique ID
    number, required
    1
  • amount
    Amount to deposit
    number, required
    102.12

Withdraw

Withdraw from your Earn wallet

Withdraw From Earn Wallet

Request
object
  • offerId
    Offer unique ID
    number, required
    1
  • amount
    Amount to withdraw
    number, required
    102.12

Earn History

List of Earn history events

Get Earn History

URI Parameters
assets

Comma separated Asset code. See Get Market Assets code for all market codes

fromTimestamp in milliseconds to get records from
toTimestamp in milliseconds to get records to
typesComma separated events.
limitNumber of entries you would like returned
pageFor pagination
sortByField to sort on
sortDirection

Direction to sort on (ASC, DESC)

Response
array
  • object

Funds


Withdrawal

This function will send withdrawal request to server

Request Withdrawal

URI Parameters
assetCode

Currency code. See Get Market Assets code for all market pairs

Request
object
  • quantity
    Quantity of asset to withdraw
    string, required
    1.243
  • address_id
    Id of address to withdraw to
    number, required
    3
  • reason
    Reason for withdrawing
    enum, required
Response
object
  • result
    Result of withdrawal attempt
    string
    success
  • status
    Current status of POLi deposit
    enum
  • withdrawalId
    Id of withdrawal
    number
    971
Request
object
  • quantity
    Quantity of asset to withdraw
    string, required
    1.243
  • address_id
    Id of address to withdraw to
    number, required
    3
  • reason
    Reason for withdrawing
    enum, required
Response
object
  • error
    object, required

Withdrawal Permissions

This function will check the withdrawal permissions for a given asset

Check Withdrawal Permissions

URI Parameters
assetCode

Currency code. See Get Markets code for all market pairs

Response
object
  • canWithdraw
    Whether or not the user is allowed to withdraw this asset
    boolean
    true
  • message
    Message describing permissions
    string
    Withdrawals are allowed for BTC
Response
object
  • error
    object, required

History


Currency Withdraw History

List of withdraw history events for a currency

Get Currency Withdraw History

URI Parameters
asset

Asset code. See Get Market Assets code for all market codes

limitNumber of entries you would like returned
pageFor pagination
sortBy

Field and direction to sort on (prefix with +/- to indicate direction)

Response
object
  • id
    ID of event
    number, required
    1
  • time
    Timestamp of event
    number, required
    1517458855347
  • quantity
    Quantity of asset
    string, required
    1231.123
  • address_id
    ID of address
    number, required
    1
  • status
    Status of event
    enum, required
Response
object
  • error
    object, required

Currency Deposit History

List of deposit history events

Get Currency Deposit History

URI Parameters
asset

Asset code. See Get Market Assets code for all market codes

limitNumber of entries you would like returned
pageFor pagination
sortBy

Field and direction to sort on (prefix with +/- to indicate direction)

Response
object
  • id
    ID of event
    number, required
    1
  • time
    Timestamp of event
    number, required
    1517458855347
  • quantity
    Quantity of asset
    string, required
    1231.123
  • address_id
    ID of address
    number, required
    1
  • status
    Status of event
    enum, required
Response
object
  • error
    object, required

All Withdraw History

List of withdraw history events for all currencies

Get All Withdraw History

URI Parameters
limitNumber of entries you would like returned
pageFor pagination
sortBy

Field and direction to sort on (prefix with +/- to indicate direction)

Response
object
  • id
    ID of event
    number, required
    1
  • time
    Timestamp of event
    number, required
    1517458855347
  • quantity
    Quantity of asset
    string, required
    1231.123
  • address_id
    ID of address
    number, required
    1
  • status
    Status of event
    enum, required
Response
object
  • error
    object, required

All Deposit History

List of deposit history events for all currencies

Get All Deposit History

URI Parameters
limitNumber of entries you would like returned
pageFor pagination
sortBy

Field and direction to sort on (prefix with +/- to indicate direction)

Response
object
  • id
    ID of event
    number, required
    1
  • time
    Timestamp of event
    number, required
    1517458855347
  • quantity
    Quantity of asset
    string, required
    1231.123
  • address_id
    ID of address
    number, required
    1
  • status
    Status of event
    enum, required
Response
object
  • error
    object, required

All Transaction History

Returns basic information on all trades, withdrawals and deposits

Get History

URI Parameters
limitNumber of entries you would like returned
pageFor pagination
sortBy

Field and direction to sort on (prefix with +/- to indicate direction)

Response
array
  • object
  • object
Response
object
  • error
    object, required

Affiliate Payout History

List of Affiliate Payout events

Get Affiliate Payout History

URI Parameters
limitNumber of entries you would like returned
pageFor pagination
sortBy

Field and direction to sort on (prefix with +/- to indicate direction)

Response
array
  • object
Response
object
  • error
    object, required

Info


Info

Get Info

Response
object
  • version

    API version in https://semver.org/ format

    string, required
    1.242.1
  • maintenanceMode
    Is the server in maintenance mode.
    boolean, required
    false
  • state
    The load state of the server
    enum, required

Limits


Withdrawal Limits

Get Withdrawal limits

Response
object
  • used
    Amount of limit used in AUD
    number
    100
  • remaining
    Amount of limit remaining in AUD
    number
    9900
  • limit
    Limit available per cycle
    number
    10000
  • rollingCycleHrs

    How long each withdrawal affects the limit for. e.g 24 means that a withdrawal made 23 hrs ago will affect the limit, but a withdrawal made over 24 hours ago will no longer affect it

    number
    24

Markets


Live rates

Current prices for all assets against asset. Currently only supported for AUD, USD and BTC.

Get Live Rates

URI Parameters
asset

Asset Id. See Get Market Assets id for all market id's

  • /1/ returns in AUD

  • /3/ returns in BTC

  • /36/ returns in USD(t)

Response
object
  • 1
    24hr pricing
    object, required
Response
object
  • error
    object, required

Market Assets

An Array of Objects which contain market name, abbreviation, icon

Get Market Assets

Response
array
  • object
  • object
  • object
Response
object
  • error
    object, required

Basic Asset Info

Basic information about assets. If parameter left blank, returns all traded assets on Swyftx.

Get Basic Info

URI Parameters
assetCodeAn asset code
Response
array
  • object

Detailed Asset Info

Detailed information about assets. If parameter left blank, returns all traded assets on Swyftx.

Get Detailed Info

URI Parameters
assetCodeAn asset code
Response
array
  • object

Messages


Messages

Get Latest

URI Parameters
limit

Maximum messages returned, returns all if empty

Response
array
  • object

Announcements

Get Latest

URI Parameters
limit

Maximum messages returned, returns all if empty

Response
array
  • object

Orders


Pair Exchange Rate

Exchange rate for pair

Get Pair Exchange Rate

Request
object
  • buy

    What asset to buy. See Get Market Assets code for all market codes

    enum, required
  • sell

    What asset to sell. See Get Market Assets code for all market codes

    enum, required
  • amount

    At what depth to calculate rate to. If amount not included, midpoint rate returned

    string, optional
    1000
  • limit

    Which asset the amount is in, required if amount set. See Get Market Assets code for all market codes

    enum, optional
Response
object
  • mid
    string, required
    3726.57
  • price
    string, required
    3730.8271
Request
object
  • buy

    What asset to buy. See Get Market Assets code for all market codes

    enum, required
  • sell

    What asset to sell. See Get Market Assets code for all market codes

    enum, required
  • amount

    At what depth to calculate rate to. If amount not included, midpoint rate returned

    string, optional
    1000
  • limit

    Which asset the amount is in, required if amount set. See Get Market Assets code for all market codes

    enum, optional
Response
object
  • error
    object, required
Request
object
  • buy

    What asset to buy. See Get Market Assets code for all market codes

    enum, required
  • sell

    What asset to sell. See Get Market Assets code for all market codes

    enum, required
  • amount

    At what depth to calculate rate to. If amount not included, midpoint rate returned

    string, optional
    1000
  • limit

    Which asset the amount is in, required if amount set. See Get Market Assets code for all market codes

    enum, optional
Response
object

price: 3730.8850 (string, required) - The price right now if you were to buy/sell the amount of limit feePerUnit: 0.006 (string, required) - The fee included in this quote in perunit. feePerUnit * 100 == fee percentage. Note this is excluded from price but included in amount and total and is applied to the asset not specified in limit amount: 0.26642471 (string, required) - Qty of buy asset. In this example, USD was limited to 1000, so the fee was applied to the amount of BTC total: 1000 (string, required) - Qty of sell asset. Because USD was limited to 1000, exactly 1000 will be sold

Request
object
  • buy

    What asset to buy. See Get Market Assets code for all market codes

    enum, required
  • sell

    What asset to sell. See Get Market Assets code for all market codes

    enum, required
  • amount

    At what depth to calculate rate to. If amount not included, midpoint rate returned

    string, optional
    1000
  • limit

    Which asset the amount is in, required if amount set. See Get Market Assets code for all market codes

    enum, optional
Response
object
  • error
    object, required

Swap Pair Exchange Rate

Exchange rate for swap pair

Get Swap Pair Exchange Rate

Request
object
  • buy

    What asset to buy. See Get Market Assets code for all market codes

    enum, required
  • sell

    What asset to sell. See Get Market Assets code for all market codes

    enum, required
  • amount

    At what depth to calculate rate to. If amount not included, midpoint rate returned

    string, optional
    1000
  • limit

    Which asset the amount is in, required if amount set. See Get Market Assets code for all market codes

    enum, optional
  • intermediary

    Which primary asset the swap should be conducted through. See Get Market Assets code for market codes for primary assets

    enum
Response
object
  • mid
    string, required
    3726.57
  • price
    string, required
    3730.8271
Request
object
  • buy

    What asset to buy. See Get Market Assets code for all market codes

    enum, required
  • sell

    What asset to sell. See Get Market Assets code for all market codes

    enum, required
  • amount

    At what depth to calculate rate to. If amount not included, midpoint rate returned

    string, optional
    1000
  • limit

    Which asset the amount is in, required if amount set. See Get Market Assets code for all market codes

    enum, optional
  • intermediary

    Which primary asset the swap should be conducted through. See Get Market Assets code for market codes for primary assets

    enum
Response
object
  • error
    object, required
Request
object
  • buy

    What asset to buy. See Get Market Assets code for all market codes

    enum, required
  • sell

    What asset to sell. See Get Market Assets code for all market codes

    enum, required
  • amount

    At what depth to calculate rate to. If amount not included, midpoint rate returned

    string, optional
    1000
  • limit

    Which asset the amount is in, required if amount set. See Get Market Assets code for all market codes

    enum, optional
  • intermediary

    Which primary asset the swap should be conducted through. See Get Market Assets code for market codes for primary assets

    enum
Response
object

price: 3730.8850 (string, required) - The price right now if you were to buy/sell the amount of limit feePerUnit: 0.006 (string, required) - The fee included in this quote in perunit. feePerUnit * 100 == fee percentage. Note this is excluded from price but included in amount and total and is applied to the asset not specified in limit amount: 0.26642471 (string, required) - Qty of buy asset. In this example, USD was limited to 1000, so the fee was applied to the amount of BTC total: 1000 (string, required) - Qty of sell asset. Because USD was limited to 1000, exactly 1000 will be sold

Request
object
  • buy

    What asset to buy. See Get Market Assets code for all market codes

    enum, required
  • sell

    What asset to sell. See Get Market Assets code for all market codes

    enum, required
  • amount

    At what depth to calculate rate to. If amount not included, midpoint rate returned

    string, optional
    1000
  • limit

    Which asset the amount is in, required if amount set. See Get Market Assets code for all market codes

    enum, optional
  • intermediary

    Which primary asset the swap should be conducted through. See Get Market Assets code for market codes for primary assets

    enum
Response
object
  • error
    object, required

Pair Exchange Rates

Exchange rate for pair

Get Pair Exchange Rates

Request
array
  • object
Response
array
  • object
Request
array
  • object
Response
object
  • error
    object, required
Request
array
  • object
Response
array
  • object
Request
array
  • object
Response
object
  • error
    object, required

Place / Update Order

Place Order

Creates an order of {orderType} for {secondary}:{primary} with {quantity} of {assetQuantity} at {trigger} price.

For limit and stop buy orders (orderType: LIMIT_BUY,STOP_LIMIT_BUY), price is primary per secondary. e.g. 52000 USD/BTC -> trigger: 52000.

For limit and stop sell orders (orderType: LIMIT_SELL,STOP_LIMIT_SELL), price is secondary per primary. e.g. 1 BTC / 52000 USD -> trigger: 0.0000192307.

Request
object
  • primary

    Asset code. See Get Market Assets code for all market codes

    enum, required
  • secondary

    Asset code. See Get Market Assets code for all market codes

    enum, required
  • quantity
    Amount to limit purchase to
    string, required
    1000
  • assetQuantity

    Asset code. See Get Market Assets code for all market codes

    enum, required
  • orderType
    Order type
    enum, required
  • trigger

    Price to trigger order at.

    For limit and stop buy orders (orderType: LIMIT_BUY,STOP_LIMIT_BUY), price is primary per secondary. e.g. 52000 USD/BTC -> trigger: 52000.

    For limit and stop sell orders (orderType: LIMIT_SELL,STOP_LIMIT_SELL), price is secondary per primary. e.g. 1 BTC / 52000 USD -> trigger: 0.0000192307.

    string, optional
    52000
Response
object
  • orderUuid
    string, required
    ord_4TgCaoJc7pY...
  • order
    object, required
  • processed
    boolean, required

Update Order

Updates an existing limit or stop order's {quantity} of {assetQuantity} at {trigger} price.

Request
object
  • orderUuid

    The order's Uuid

    string, required
    ord_F5Docr9bjJuHs3BNMiSdrn
  • quantity
    Amount to limit purchase to
    number, optional
    1000
  • assetQuantity

    Asset code. See Get Markets code for all market codes

    enum, optional
  • trigger

    Price to trigger order at. Price is primary per secondary. e.g. USD/BTC

    number, optional
    6000
Response
object
  • orderUuid
    The order uuid of the updated order
    string, required
    ord_F5Docr9bjJuHs3BNMiSdrn

Dust Order

Sells leftover untradable amounts of selected assets into selected base currency. Rate limited to one successful dust per day. Multiple assets may be dusted in one request.

Dust Order

Request
object
  • selected

    Asset code. See Get Market Assets code for all market codes

    array, required
  • primary

    Primary asset code to dust to. See Get Market Assets code for all market codes

    enum, required
Response
array
  • object
Request
object
  • selected

    Asset code. See Get Market Assets code for all market codes

    array, required
  • primary

    Primary asset code to dust to. See Get Market Assets code for all market codes

    enum, required
Response
object
  • error
    object, required

Cancel Order

Cancel Order

URI Parameters
orderUuidThe UUID of the order to cancel

List Orders

List of all orders filtered by assetCode, if no code provided, returns all orders.

Get Orders

URI Parameters
assetCode

Asset Code to filter by. See Get Market Assets code for all market codes

limitNumber of entries you would like returned
pageFor pagination
Response
array
  • object

Get Order by orderUuid

Get an order by it's orderUuid.

Get Orders

URI Parameters
orderUuidUnique order id
Response
object
  • orderUuid
    Unique order id
    string, required
    ord_123abc...
  • order_type
    Type of order
    enum, required
  • primary_asset

    Asset ID. See Get Market Assets id for all market ids

    enum, required
  • secondary_asset

    Asset ID. See Get Market Assets id for all market ids

    enum, required
  • quantity_asset

    Which asset to limit on. See Get Market Assets id for all market ids

    enum, required
  • quantity

    Amount of quantity_asset to trade

    number, required
    100
  • trigger

    Price to trigger on - null if market order_type

    number, optional
    8500
  • status
    Order status
    enum, required
  • created_time
    Time in milliseconds that the order was placed
    number, required
    1596684928098
  • updated_time
    Time in milliseconds that the order was updated
    number, required
    1596684928098
  • amount
    Amount of asset bought
    number, optional
    100
  • total
    Amount of asset sold
    number, optional
    0.01
  • rate
    Rate asset was sold at
    number, optional
    0.01
  • audValue
    Final total price
    number, optional
    8501.025
  • userCountryValue
    Final total price
    number, optional
    8501.025
  • feeAmount
    Fee amount of total price
    number, optional
    12.25
  • feeAsset

    Asset ID. See Get Market Assets id for all market ids

    enum, optional
  • feeAudValue
    Fee amount of total price
    number, optional
    40.25
  • feeUserCountryValue
    Fee amount of total price
    number, optional
    40.25

Portfolio


Get Trade Price History

Get average price paid for assets denoted in the specified asset

Get Trade Price History

URI Parameters
denotedAssetId

Asset Id. See Get Market Assets id for all market id's

Response
object
  • 3
    asset id
    object

Get Asset History

Get buy/sell/withdrawal/deposit history of specified asset

Get Asset History

URI Parameters
assetId

Asset Id. See Get Market Assets id for all market id's

pagepage number
limititems per page
sortKeyfield on which to sort items
sortDirectionfield on which to sort items
startDateonly return results from after this timestamp
endDateonly return results from before this timestamp
typecomma separated list of types to include
statuscomma separated list of statuses to include
Response
object
  • items
    array
  • runningTotal
    running balance total at first item in page. Only calculated if sorting on date and not filtering
    string
    0.422331
  • recordCount
    total number of items matching query
    number
    122

Get All Assets History

Get buy/sell/withdrawal/deposit history of all assets

Get All Assets History

URI Parameters
page

page number, defaults to 1 when the value is invalid

limit

items per page, defaults to 10 when the value is invalid

sortKey

field on which to sort items, removed when value is invalid

sortDirection

field on which to sort items, removed when value is invalid

startDateonly return results from after this timestamp
endDateonly return results from before this timestamp
type

comma separated list of types to include, removed when value is invalid

status

comma separated list of statuses to include, removed when value is invalid

Response
object
  • items
    array
  • recordCount
    total number of items matching query
    number
    122

Recurring Orders


Get Recurring Orders

Get all active recurring orders.

Get Recurring Orders

Response
array
  • object

Get Recurring Order Stats

Get all active recurring orders.

Get Recurring Order Stats

URI Parameters
templateUuidUuid of the template to retrieve stats for
Response
array
  • object
  • object

Create Recurring Order

Create a new recurring order.

Create Recurring Order

Request
object
  • template
    object, required
  • primaryAssetId
    Id of the asset being deposited
    enum, required
  • label
    Label on the recurring order
    string, required
    BTC & ETH
  • source

    Source of the funds, currently only DEPOSIT supported.

    string, required
    DEPOSIT
Response
object
  • template
    object, required
  • templateKey
    The deposit reference for this recurring order.
    string, required
    A1B2C3

Delete Recurring Order

Delete a recurring order.

Delete Recurring Order

URI Parameters
templateUuidUuid of the template to retrieve stats for

Swap


Swap Crypto Assets

Automate buying and selling between two crypto assets

Execute Swap

Request
object
  • buy

    Asset ID. See Get Market Assets id for all market ids

    enum, required
  • sell

    Asset ID. See Get Market Assets id for all market ids

    enum, required
  • limitAsset
    Asset ID that limitQty will be applied to
    number, required
    3
  • limitQty
    quantity of crypto asset to sell
    string, required
    0.5
  • intermediateAssetId

    sell asset will first be traded to this, then buy asset will be bought using this. Default currency will be used by default.

    enum, optional
Response
object
  • buyResult
    details of the buy side of the swap
    object, required
  • sellResult
    details of the sell side of the swap
    object, required

Data Structures

Order Status
enum
  • 1
    number, fixed

    Open (order is waiting to be executed as a trade)

  • 2
    number, fixed

    Insufficient Balance Cancelled (order was cancelled because not enough balance)

  • 3
    number, fixed

    Partial (order is not completed to full amount)

  • 4
    number, fixed

    Filled (order is completed to full amount)

  • 5
    number, fixed

    Pending (currently processing the trade)

  • 6
    number, fixed

    User Cancelled (order was cancelled because user said so)

  • 7
    number, fixed
    Order failed for unknown reason
  • 8
    number, fixed

    System Cancelled (Order cancelled by Swyftx)

  • 9
    number, fixed
    Failed due to being below the minimum trade amount
  • 10
    number, fixed

    Refunded (Order rolled back)

  • number
Order Type
enum
  • 1
    number, fixed

    market buy Buys secondary asset immediately at current market rates

  • 2
    number, fixed

    market sell Sells secondary asset immediately at current market rates

  • 3
    number, fixed

    limit buy Buys secondary asset when price drops to trigger price

  • 4
    number, fixed

    limit sell Sells secondary asset when price rises to trigger price

  • 5
    number, fixed

    stop limit buy Buys secondary asset if price rises to trigger price

  • 6
    number, fixed

    stop limit sell Sells secondary asset if price drops to trigger price

  • 8
    number, fixed

    dust sell An order placed from dusting

  • number
Order Type String
enum
  • enum[number]
  • 1
    number, fixed

    MARKET_BUY - Buys secondary asset immediately at current market rates

  • 2
    number, fixed

    MARKET_SELL - Sells secondary asset immediately at current market rates

  • 3
    number, fixed

    LIMIT_BUY - Buys secondary asset when price drops to trigger price

  • 4
    number, fixed

    LIMIT_SELL - Sells secondary asset when price rises to trigger price

  • 5
    number, fixed

    STOP_LIMIT_BUY - Buys secondary asset if price rises to trigger price

  • 6
    number, fixed

    STOP_LIMIT_SELL - Sells secondary asset if price drops to trigger price

  • number
Auth Object
object
  • access_token
    Access token used for future authenticated requests to the API
    string, required
    eyJz93a...k4laUWw
  • id_token
    ID Token
    string, required
    eyJz93a...i5SDns9o
  • expires_in
    How many seconds until access token expires
    number, required
    86400
  • token_type
    Token Type
    string, required
    Bearer
General Error
object
  • error
    object
Forbidden Error
object
  • error
    object
Access Token
object
  • accesstoken
    string, required
    urn:ietf:params:oauth:grant-type:jwt-bearer
Asset Code
enum
  • AUD
    string, fixed

    Asset code. See Get Market Assets code for all market codes

  • BTC
    string, fixed
  • USD
    string, fixed
  • string
Asset ID
enum
  • 1
    number, fixed

    Asset ID. See Get Market Assets id for all market ids

  • 3
    number, fixed
  • 36
    number, fixed
  • number
Markets Base
object
  • id

    Asset ID. See Get Market Assets id for all market ids

    enum, required
  • name
    Asset Name
    string, required
    Australian Dollars
  • code

    Asset code. See Get Market Assets code for all market codes

    enum, required
  • minimum_order

    Smallest amount allowed to be traded at a time. Amount must be greater than minimum_order

    string, required
    0.001
  • price_scale
    Decimal places to show
    number, required
    6
  • deposit_enabled
    boolean, required
    true
  • withdraw_enabled
    boolean, required
    true
  • min_confirmations
    How many confirmations required before accepting deposit
    number, optional
    3
  • min_withdrawal
    Minimum quantity of asset to withdraw at a time
    number, required
    5
  • minimum_order_increment
    The smallest amount that orders can be incremented by
    number, required
    0.000001
  • mining_fee
    The cost of withdrawing the asset
    number, required
    5
  • primary
    If this asset can be a base asset
    boolean, required
    true
  • secondary
    If this asset can be a secondary asset
    boolean, required
    true
Order History Base
object
  • id
    ID of event
    number, required
    1
  • date
    Date of event
    number, required
    1517458855347
  • type
    Type of History
    string, required
    buy
  • buy

    Asset code. See Get Market Assets code for all market codes

    enum, required
  • sell

    Asset code. See Get Market Assets code for all market codes

    enum, required
  • price
    Price per buy asset
    string, required
    10000
  • cost
    Cost of the order in sell asset
    string, required
    5000
  • vol
    Volume of buy currency purchased
    string, required
    .5
  • amount

    Amount of limit currency used in order

    string, required
    .5
  • limit

    Asset code. See Get Market Assets code for all market codes

    enum, required
Rate Quote Base
object
  • buy

    Asset code. See Get Market Assets code for all market codes

    enum, required
  • sell

    Asset code. See Get Market Assets code for all market codes

    enum, required
  • price
    Price per buy asset
    string, required
    10000
  • cost
    Cost of the order in sell asset
    string, required
    5000
  • vol
    Volume of buy currency purchased
    string, required
    .5
  • amount

    Amount of limit currency used in order

    string, required
    .5
  • limit

    Asset code. See Get Market Assets code for all market codes

    enum, required
Funding History
object
  • history
    array, required
Funding History Base
object
  • id
    ID of event
    number, required
    1
  • time
    Timestamp of event
    number, required
    1517458855347
  • quantity
    Quantity of asset
    string, required
    1231.123
  • address_id
    ID of address
    number, required
    1
  • status
    Status of event
    enum, required
Fund History Status Base
enum
  • 1
    number, fixed
    Created
  • 2
    number, fixed
    Processed and completed
  • 3
    number, fixed

    Rejected (network/validation/etc.)

  • 4
    number, fixed
    Failed
  • 5
    number, fixed
    Failed due to minimum requirements
  • 6
    number, fixed
    Pending
  • 7
    number, fixed
    Pending Daily Limits
  • 8
    number, fixed
    Pending
  • 9
    number, fixed
    Pending verification
  • 10
    number, fixed
    Refunded
  • 11
    number, fixed
    Pending
  • 12
    number, fixed
    Pending
  • 13
    number, fixed
    Cancelled
  • 14
    number, fixed
    Unconfirmed
  • 15
    number, fixed
    Pending verification
  • 16
    number, fixed
    Processing
  • 17
    number, fixed
    Pending
  • number
Verification Status
enum[string, fixed]
  • unverified
    Item is not verified
  • pending
    Item is in the process of verification
  • verified
    Item is verified
Verification
object
User Profile
object
  • dob
    Date of Birth
    number, required
    757346400000
  • name
    Name
    object, required
  • email
    Email Address
    string, required
    john.doe@example.com
  • phone
    Phone Number
    string, required
    +614XXXXXXXX
  • currency
    Asset to display values in. Base asset selected from drop down
    object, required
  • user_hash
    Internal use
    string, optional
    xxxx...xxxx
  • metadata
    Metadata properties
    object, required
  • userSettings
    User settings
    object
User Profile Base
object
  • name
    Name
    object, required
  • email
    Email Address
    string, required
    john.doe@example.com
  • phone
    Phone Number
    string, required
    +614XXXXXXXX
  • currency
    Asset to display values in. Base asset selected from drop down
    object, required
  • user_hash
    Internal use
    string, optional
    xxxx...xxxx
  • metadata
    Metadata properties
    object, required
User Profile Settings
object
  • userSettings
    User settings
    object
Tax Report Line
object
  • date
    string
    4/06/2020
  • time
    string
    14:21:03
  • event
    string
    sell
  • asset
    string
    AUD
  • amount
    string
    500.00000000
  • currency
    string
    USD
  • value
    string
    343.35520439
  • rate
    string
    0.68671041
  • audValue
    string
    500.00000000
  • feeAmount
    string
    null
  • feeAsset
    string
    null
  • feeAudValue
    string
    null
  • gst
    string
    null
  • exGST
    string
    null
  • depositedTo
    string
    null
  • withdrawnTo
    string
    null
  • withdrawalFee
    string
    null
  • reference
    string
    null
  • txId
    string
    null
  • uuid
    string
    null
Tax Report Balance
object
  • date
    string
    30/06/2020
  • time
    string
    23:59:59
  • event
    string
    open position
  • asset
    string
    USDT
  • amount
    string
    23.84373701
  • currency
    string
    null
  • value
    string
    null
  • rate
    string
    null
  • audValue
    string
    33.04021869
Timestamp
number

1517316338030 - Time in milliseconds since epoch

DD Address
object
  • id
    ID of address
    number, required
    1
  • code

    Asset code. See Get Market Assets code for all market codes

    enum, required
  • address_details
    object, required
  • time
    Time created in milliseconds since epoch
    number, required
    1517316338030
  • name
    Friendly name for address
    string, required
    My BTC Address
  • type
    Address purpose
    enum, required[string, fixed]
Crypto Address
object
  • id
    ID of address
    number, required
    1
  • code

    Asset code. See Get Market Assets code for all market codes

    enum, required
  • address_details
    object, required
  • time
    Time created in milliseconds since epoch
    number, required
    1517316338030
  • name
    Friendly name for address
    string, required
    My BTC Address
  • type
    Address purpose
    enum, required[string, fixed]
Address Base
object
  • id
    ID of address
    number, required
    1
  • code

    Asset code. See Get Market Assets code for all market codes

    enum, required
  • address_details
    Address
    object, required
  • time
    Time created in milliseconds since epoch
    number, required
    1517316338030
  • name
    Friendly name for address
    string, required
    My BTC Address
  • type
    Address purpose
    enum, required[string, fixed]
Address Type Base
object
  • type
    Address purpose
    enum, required[string, fixed]
DD Address Base
object
  • name
    Account Name
    string, required
    Mr John Doe
  • bsb
    BSB
    string, required
    123456
  • number
    Account number
    string, required
    12345678
Crypto Address Base
object
  • address
    Address
    string, required
    18PpTWTShSsHuJ5ze23gU2rmsQbAVVMZia
  • destination_tag

    Up to one field required, please check for your asset or currency.

    string, optional
    654987312
  • payment_id

    Up to one field required, please check for your asset or currency.

    string, optional
    654987312
  • memo

    Up to one field required, please check for your asset or currency.

    string, optional
    memo text
  • biller_code

    Up to one field required, please check for your asset or currency.

    string, optional
    321654
  • bsb

    Up to one field required, please check for your asset or currency.

    string, optional
    654-312
  • payid

    Up to one field required, please check for your asset or currency.

    string, optional
    email@address.example
  • reference

    Up to one field required, please check for your asset or currency.

    string, optional
    654987312519
  • message

    Up to one field required, please check for your asset or currency.

    string, optional
    b&2H_8s!...
Deposit Address Base
object
  • name
    Friendly name for address
    string, required
    My BTC Address
Withdraw Address Base
object
  • address_details
    Address
    object, required
  • name
    Friendly name for address
    string, required
    My BTC Address
Trading View Resolutions
enum[string, fixed]
  • 1
    1 Minute
  • 3
    3 Minutes
  • 5
    5 Minutes
Tradingview Bars
object
  • time
    Time in milliseconds since epoch
    number, required
    1501545600000
  • open
    Opening price for bar
    string, required
    4261.48000000
  • high
    Highest price for bar
    string, required
    4745.42000000
  • low
    Lowest price for bar
    string, required
    3400.00000000
  • close
    Closing price for bar
    string, required
    4724.89000000
  • volume
    Volume of orders for bar
    number, required
    10015
Message
object
  • id
    Id of message
    number
  • type
    Type of message
    enum
  • title
    Title of article
    string
    Android & iOS Mobile Apps
  • message
    Message contents
    string
    Head over to ...
  • icon
    Icon for article
    string
    fa-handshake
  • link
    Link to relevant material
    string
    http://reddit...
  • created
    When the article was created
    number
    1577922001693
  • expire
    When the article will expire
    number
    1577922001693
Chart Bar
object
Asset History Item
object
  • date
    Time in milliseconds that the item was last updated
    number, required
    1596684928098
  • amount
    Amount denoted in the specified asset
    string, required
    0.01
  • movement
    Net balance movement imposed by this item
    string, required
    0.01
  • approxMovement

    For pending triggered orders, this will be the estimated movement of the specified asset

    string, required
    0.0125
  • userCountryValue

    Value denoted in the users country asset (AUD for Australian users, etc)

    string, required
    1521
  • uuid
    uuid of history item
    string, required
    ord_123abc...
  • type
    type of activity item
    enum, required
  • status
    status of activity item
    enum, required
  • statusRaw
    status code of activity item
    number, required
  • orderType

    order type code, only available for items of type 'BUY' or 'SELL'

    number
  • secondaryAsset

    the specified asset id for 'WITHDRAWALS' and 'DEPOSITS', or the secondary asset for 'BUY' and 'SELL' items

    number
  • primaryAsset

    null for 'WITHDRAWALS' and 'DEPOSITS', or the primary asset for 'BUY' and 'SELL' items

    number
  • limitAsset

    null for 'WITHDRAWALS' and 'DEPOSITS', or the limit asset for 'BUY' and 'SELL' items

    number
  • trigger

    null for 'WITHDRAWALS' and 'DEPOSITS', or the trigger price for 'BUY' and 'SELL' items

    string
  • secondaryAmount

    the amount of secondary asset transacted - applies to all history item types

    string
  • primaryAmount

    the amount of primary asset transacted - only applies to 'BUY' and 'SELL' history items

    string
  • label

    the address label for the withdraw or deposit item - only applies to 'WITHDRAWALS' and 'DEPOSITS' history items

    string
  • address

    the address details for the history item - only applies to 'WITHDRAWALS' and 'DEPOSITS' history items

    string
  • addressMetadata

    any additional metadata for the address details - only applies to 'WITHDRAWALS' and 'DEPOSITS' history items

    object
Asset History Item Address Metadata
object
  • bsb
    Bank account BSB
    string
  • memo
    Crypto address memo
    string
Asset History Item Type
enum
  • DEPOSIT
    string, fixed
    deposit
  • WITHDRAWAL
    string, fixed
    withdrawal
  • BUY
    string, fixed
    buy
  • SELL
    string, fixed
    sell
  • string
Asset History Item Status
enum
  • PENDING
    string, fixed
    pending
  • COMPLETED
    string, fixed
    completed
  • FAILED
    string, fixed
    failed
  • string
Asset History Sort Key
enum
  • date
    string, fixed
    date of last update to item
  • amount
    string, fixed
    balance denoted in specified asset
  • userCountryValue
    string, fixed

    value denoted in currency of user's country

  • string
Sort Direction
enum
  • ASC
    string, fixed
    ascending order
  • DESC
    string, fixed
    descending order
  • string
Chart Resolution
enum[string, fixed]
  • 1m
  • 5m
  • 1h
  • 4h
  • 1d
Scope
object
  • display
    Display name for permissions
    string
  • desc
    Description of the scope
    string
  • key
    Key found within the JWT
    enum[string, fixed]
  • state
    Reserved for future use
    number
History Entry
object
  • asset
    Asset id
    number
    3
  • amount
    Amount of asset
    number
    1.234
  • updated
    Last updated
    number
    15326574115
  • actionType
    enum[string, fixed]
  • status
    enum, required
Swap Order Result
object
  • processed
    whether or not the order was filled
    boolean, required
    true
  • message
    explanation of order status if not processed
    string
    'Abandoned buy order due to unprocessed sell order'
  • order
    Order Details if successfully proccessed
    object
Reward Event
enum
  • DEPOSIT
    string, fixed
    Deposits into wallet
  • WITHDRAWAL
    string, fixed
    Withdrawals from wallet
  • REWARD
    string, fixed
    Rewards paid out
  • string
Price Alert Status
enum[string, fixed]
  • 1
  • 2
  • 3
  • 4
Price Alert Direction
enum[string, fixed]
  • 1
  • 2
Scopes
enum[string, fixed]
  • app.account.affiliation
    Can view information about and enroll in the affiliate program
  • app.account.modify
    Can modify account settings
  • app.account.tax-report
    Can request a tax report
  • app.account.verification

    Can complete email/phone/id verification processes

  • app.account.balance

    Can get information about the balance of the account (assets, amounts, etc.)

  • app.account.stats
    Can get statistics about the usage of the account
  • app.account.read
    Can retrieve profile information
  • app.recurring-orders.read
    Can read recurring order templates
  • app.recurring-orders.create
    Can create new recurring order templates
  • app.recurring-orders.delete
    Can delete recurring order templates
  • app.address.add

    Can add new withdrawal/deposit addresses

  • app.address.remove

    Can remove withdrawal/deposit addresses

  • app.address.check-deposit
    Can initiate checking for deposits on relevant assets
  • app.address.read

    Can view withdrawal/deposit address information

  • app.funds.withdraw
    Can make withdrawals to registered addresses
  • app.funds.withdrawal-limit
    Can retrieve information about current withdrawal limits and usage
  • app.funds.read

    Can see withdrawal/deposit history

  • app.orders.create

    Can create new buy/sell orders

  • app.orders.delete

    Can delete existing buy/sell orders

  • app.orders.read

    Can view existing buy/sell orders

  • app.orders.dust
    Can dust assets
  • app.api.revoke
    Can revoke API keys
  • app.api.read
    Can view information about active API Keys
Withdrawal Reasons
enum
  • 1
    number, fixed

    Paying for Goods/Services

  • 2
    number, fixed
    Paying for Ransomware
  • 3
    number, fixed
    Transfer to Personal Wallet
  • 4
    number, fixed

    Transfer to Custody/Interest Platform

  • 5
    number, fixed
    Trading on another Exchange
  • 6
    number, fixed
    Not happy with Swyftx
  • 7
    number, fixed
    Sending to a friend
  • 8
    number, fixed
    Transfer to my Bank Account
  • number
Withdrawal Status
enum
  • 1
    number, fixed
    Pending
  • 2
    number, fixed
    Complete
  • 3
    number, fixed
    Failed
  • 4
    number, fixed
    Failed
  • 5
    number, fixed
    Failed
  • 6
    number, fixed
    Pending
  • 7
    number, fixed
    Pending
  • 8
    number, fixed
    Pending
  • 9
    number, fixed
    Pending
  • 10
    number, fixed
    Refunded
  • 11
    number, fixed
    Pending
  • 15
    number, fixed
    Pending
  • 16
    number, fixed
    Pending
  • 17
    number, fixed
    Pending
  • 18
    number, fixed
    Refunded
  • number
Dashboard Tile Names
enum
  • announcement
    string, fixed
  • portfolio
    string, fixed
  • favourites
    string, fixed
  • activity
    string, fixed
  • statistics
    string, fixed
  • history
    string, fixed
  • movers
    string, fixed
  • news
    string, fixed
  • refer
    string, fixed
  • account
    string, fixed
  • security
    string, fixed
  • string
Load State
enum
  • 0
    number, fixed
    LOADING
  • 1
    number, fixed
    COMPLETE
  • 2
    number, fixed
    ERROR
  • number

Errors


Common error responses

Authentication

Authentication

Response
object
  • error
    object