An Application Programming Interface key (API key) is a unique identifier used to authenticate a user, developer, or calling program to an API.

Essentially, they can be used to allow someone, such as your accountant, external access to your Swyftx account on the conditions that you set when creating the key.

When creating the key, there are processes you can use to allow read-only access to your account, meaning there is no ability to take actions such as buy, sell, withdraw and deposit via your account.

You can choose different parameters that allow someone to use the key only under specific circumstances. These options are all made clear when creating the key.

For example, someone, such as your accountant, may use an API Key and have access to your account purely to generate a transaction report.

How to create an API key

• App

  1. Select the three lines in the top left corner to expand the side menu, then select  Profile.
  2. Select  API Keys.
  3. Select Create new key, then select Continue.
  4. Choose the type of key you want to create. You can select a pre-defined scope or select a custom API.
  5. Enter an API key title.
  6. Review the key configuration, then select Confirm.
  7. Enter your password, then select Create key.
  8. Your API key and access token will display.

  Please make a note of your API key. If lost, we cannot provide it, and you will need to make a new key.

• Web

  1. Select your circled initial in the top right corner of the dashboard and select Account settings.
  2. Select API keys from the profile menu, then select Create a key.
  3. Select I understand.
  4. Enter a title to keep track of this key.
  5. Select a pre-defined scope or select show advanced configuration to set advanced configuration.
  6. Select Continue.
  7. Enter your password, then select Continue.
  8. Your API key and access token will display.

  Please make a note of your API key. If lost, we cannot provide it, and you will need to make a new key.

Revoke API keys

• App

  1. Select the three lines in the top left corner to expand the side menu, then select  Profile.
  2. Select API Keys from the menu.
  3. To revoke an individual API key:
     
     From the Active keys list, select the API key you wish to revoke. Select Revoke API key, then select Revoke API key again to complete the action.
     
     To revoke all API keys:
     
     Select Revoke all keys, then select Revoke all keys again to complete the action.

• Web

  1. Select your circled initial in the top right corner of the dashboard and select Account settings.
  2. Select API keys from the profile menu.
  3. To revoke an individual API key:
     
     Select the ellipsis  in the row of the API key you wish to remove. Select Remove, then select Yes, revoke to complete the action.
     
     To revoke all API keys:
     
     Select Revoke all keys, then select Yes, revoke to complete the action.