API

Overview

Whispertrades offers a REST API for you to read and maintain your Whispertrades account and bots outside of the Whispertrades website itself.

The API will allow you to do such things as pull bot performance history into your own application and also start, stop, and modify bots using your own, external criteria that may not be available inside of the Whispertrades platform.

Enrollment

Before you can access the API, you must read and agree to the API terms and acknowledge that you have done so within your account. To do this, please refer to the "API" section in your account settings.

Document image


After you agree to the API terms, you will be taken to a page where you can manage API tokens that will be used to authenticate your application(s) that use the API.

Authentication

To authenticate with the API, you will need to include a Bearer Token with all of your API requests. You can create and manage your API tokens from your Whispertrades API page.

Create a Token

To create a new token, visit your API page and click "Create Token" at the top. You will be prompted for a token name and also permissions for the token.

TOKEN SECURITY

Only grant token permissions that you intend to use.

Keep your token in a secure place. Do not share your token or include it in your source code.

Tokens should remain private, encrypted, and not shared. Any person or application with access to your token can access all API features that you grant to the token.

Whispertrades is not responsible for actions or damages resulting from a lost or stolen token, and Whispertrades maintains the right to revoke API access from those who do not properly secure their API tokens.

After you create the token, it will display on screen. You must copy and save that token for your own use. An existing token cannot be retrieved again after you have left the generation screen.

Edit a Token

You can change the name, permissions, or expiration date on any existing token by clicking the edit icon next to the token.

Revoke a Token

You can revoke a token at any time by clicking on the delete icon next to the token. A deleted token will immediately lose access to the API.

Use a Token

For API calls to succeed, you must include a token (created above) in the Authorization header with each API request. This is commonly referred to as a Bearer Token.

A valid token has access to all resources in your Whispertrades account with the permissions that you grant the token.

Token Expiration

All new tokens expire in 1 year. You can view each token's expiration date in your token list.

Before expiration, you will need to either extend your current token's expiration or create a new token and replace it in your application. We will send emails before expiration to remind you to generate a new token.

Do not rely on expiration for unused tokens. You should delete/revoke tokens that you no longer intend to use.

Rate Limits

All API requests are limited to 30 per minute. This is on a Whispertrades account basis, not a token basis.

Responses

To maintain a consistent experience across the API, you can expect the following response for each API request:

JSON

  • success: indicates whether or not your request succeeded
  • message: text that describes the result
  • data: content of the requested resource(s)



Updated 01 May 2024
Did this page help you?