Skip to main content

API General

What is an API?​

API stands for Application Programming Interface and it is a program that enables one software to interact with the other. The API is a messenger taking requests and telling a system what the user wants it to do then returns the response back to the user. APIs are used extensively in providing data services across a range of fields and contexts.

How is API used in Tealstreet?​

API in trading enables you to interact with the trading system. To be more specific, it allows you to interact directly with your favorite exchange. Connecting your API with Tealstreet enables you to directly connect with the exchange. You can display your wallet balance, place trades and manage your positions.

How do I connect my API to Tealstreet?​

Connecting your API to Tealstreet is the same process for every exchange offered.

  • Login to your Tealstreet account.

    • V3 requires a new account.

  • Click the 'Settings' button near the top right corner of the terminal.

Adding API
  • Choose the exchange your want to connect to from the dropdown menu.
Dropdown
  • Generate the API key on the exchange you selected and paste it into the Tealstreet terminal to connect it.

For exchange specific tutorials on obtaining your API keys, please see the following links:

  • After you create your API key you may need to whitelist certain IP addresses. Head over to the Tealstreet window where you setup the API keys and copy the whitelisted IP(s) and paste them on the exchange website.
note

You can whitelist multiple IP(s).

You do not need to manually input IP Addresses on certain exchanges (Bybit, OKX, BloFin) where Tealstreet is an officially supported 3rd Party App. These exchanges have a selector option instead of manual input which is usually named Third-party App or similar.

  • Once you have filled in all the required information and pasted the Key and Secret from the exchange website you can click the 'Create' button. Its a good idea to double check you've copied the API and Secret correctly or else the accounts will not be linked and you cannot trade until its correct!
caution

IP Whitelisting is required if you are using the TS Network option when making the API key.

  • If linked successfully your API Key will automatically activate and you can start trading!

trade

  • You can activate/deactive multiple API's at the same time, however only one will be the active at a time.
tip

for more information check out our Quick Start Guide.