This section answers questions about the integration of SimpleSwap API.

What is API?

API, or Application Programming Interface, is one of the tools of the SimpleSwap Affiliate Program. Our affiliated partners can integrate this application into their websites (for example, crypto services, payment systems, etc.) to receive rewards in BTC for crypto and fiat exchanges done through the API.

How do I integrate SimpleSwap API?

The process of integrating our API into your website is simple, just follow these steps:

• Create an account with our Affiliate Program.
• Choose API in the Web Tools section in your affiliate account.
• Create a key by clicking on the Add New button. You can create several keys and customize your profit for crypto exchanges by choosing the fee. It is 0.4% by default, but you can make it higher.
• Embed your API key to your website’s backend:

curl -X 'GET' \

'https://api.simpleswap.io/get_currency?api_key=abcdef12-3456-7890-abcd-ef1234567890&symbol=btc' \

-H 'accept: application/json'

Please note that API keys for fiat and crypto exchanges differ, and the fee for fiat exchanges (0.4%) cannot be customized.

After you get SimpleSwap API up and running, you can check the statistics related to its performance in your affiliate account.

Once your reward for finished exchanges made by the users of your website surpassed 0.008 BTC, you can go to the Payouts section and click on the Withdraw button.

How does SimpleSwap API work?

Through our API, a person who visits your website can swap crypto or fiat currencies on the spot, without having to visit our website.

What is more, you can also make requests to our service through API commands to do the following:

• Get currency information (for example, the list of all supported currencies, available pairs, etc.)
• 
  

curl -X 'GET' \

'https://api.simpleswap.io/get_all_currencies?api_key=abcdef12-3456-7890-abcd-ef1234567890' \

-H 'accept: application/json'

• Create exchange. Please note that if a user creates a fiat exchange, the API response will include a link to Guardarian. The user has to follow the link to finish the exchange.

curl -X 'POST' \

'https://api.simpleswap.io/create_exchange?api_key=abcdef12-3456-7890-abcd-ef1234567890' \

-H 'accept: application/json' \

-H 'Content-Type: application/json' \

-d '{

"fixed": true,

"currency_from": "btc",

"currency_to": "eth",

"amount": 10,

"address_to": "string",

"extra_id_to": "",

"user_refund_address": "string",

"user_refund_extra_id": "string"

}'

• Get the information about exchanges (the type, currencies, amount, status, etc.)

curl -X 'GET' \

'https://api.simpleswap.io/get_exchanges?api_key=abcdef12-3456-7890-abcd-ef1234567890&limit=100&offset=0&gte=2023-08-08T09%3A44%3A56.327Z&lte=2023-08-15T09%3A44%3A56.328Z' \

-H 'accept: application/json'

You can find more about the requests, necessary parameters, and possible errors in our API documentation. To find detailed information about what each key from the answer means, click the Schema button in the upper left corner.

Let’s look into a hypothetical example.

John is the owner of a popular blog about cryptocurrencies. He wants to provide his readers with a seamless way to swap cryptocurrencies directly on his website. Additionally, he is looking for a passive income stream. To achieve both goals, he decides to integrate the SimpleSwap API into his blog.

• John begins by signing up for the SimpleSwap Affiliate Program.
• After logging into his affiliate account, John navigates to the Web Tools section and selects the API option. Here, he clicks on the Add New button to generate a unique API key.
• John decides to customize the profit margin for crypto exchanges. He calculated that with a monthly volume of about 20 BTC, his profit on the default setting of 0.4% fee would be 0.8 BTC per month. However, if he increases it to 0.6%, the potential income would increase to 0.12 BTC.
• With the API key in hand, John proceeds to embed it into his website's backend. 
• John decided to check the available fixed-rate pairs for Ethereum. He types in his APY key, chooses “true” for the “fixed” parameter, and types ETH in the “symbol” field. However, he sees the 401 error. To see what it means, John opens up the API documentation, clicks on the Pairs section, then finds the meaning of this error (wrong API key). He comes back to check the API key field and sees that he did not copy the last two digits of the key. After fixing this information, he receives the list of all available pairs for Ethereum with a fixed rate.

You can find more information on the errors you may encounter when working with API in this section of our Helpdesk.