API - Application Programming Interface
Would you like to use our signals on your own bot or platform? No problem. Now, you can use our simple API to retrieve our latest signals and use them in your application the best way you can. Below, you will have all the required details necessary to call our API properly:
API KEY
To use our API you need to provide an API KEY on every request. If you want to get information about our free signals, you can use the word “FREE” (without quotes) as your API KEY. Otherwise, you need to have an active premium subscription and use your subscription ID as your API KEY, so you can retrieve information about our premium signals.
The API KEY is provided as the value for the “api_key” parameter. Example:
api_key=FREE
TYPE
Optionally, you can choose the type of signals you want to receive. If your don’t specify this parameter, all signals available on the processed interval will be delivered to you. Below, you have a list of the available values for the TYPE parameter:
- SHORT TERM
- SHORT/MID TERM
- SCALPING
- MID TERM
- LONG TERM
Please note that SCALPING signals are pretty rare and LONG TERM signals are not part of our service at this moment. In the example below, we are choosing SHORT TERM signals on our request:
type=SHORT TERM
Note that the space inside the term must be URLENCODED in your request. It’s something normally automatically done by your JSON libraries, but it’s good to pay attention to this detail.
INTERVAL
By default, only signals issued on the last 5 minutes will be included in your request. If you want, you can change this interval up to 20 minutes, using this parameter. We don’t recommend changing it, since signals issued more than 5 minutes ago are probably not good to use anymore. Anyway, in the example below, we are changing our request to get signals issued during the last 15 minutes:
interval=15
EXCHANGE
You can filter your request and get only signals for one specific exchange, if you want. For this, you just need to specify the exchange name in this parameter. Example:
exchange=BINANCE
RATE LIMITING
The use of our API is very limited to prevent abuses. There’s no reason someone would want to call this API with high frequency, so we are imposing the following limits by combination of IP address and API Key:
- FREE users: 1 request at every 5 minutes
- PREMIUM users: 2 requests per minute.
Any request above these limits will not be served.
REQUESTS
All requests should be done against the following URL:
https://api.cryptoqualitysignals.com/v1/getSignal
The parameters may be passed using the GET or POST method. In the example below, we are issuing a request for the latest free signals for the BINANCE exchange:
https://api.cryptoqualitysignals.com/v1/getSignal/?api_key=FREE&exchange=BINANCE
The results will always be returned in JSON format. Below you have the details about the fields returned:
- error: Error code. 0 indicates success.
- message: Error message.
- count: Number of signals returned.
- signals: Vector containing the signals. see fields below:
- id: Number of the signal.
- timestamp: Date and time when the signal was issued on UTC time zone.
- exchange: Name of the exchange this signal is meant for.
- currency: Base currency for this signal.
- coin: Coin for which the signal was created.
- buy_start: Recommended buy zone start.
- buy_end: Recommended buy zone end.
- target1: Price for the first selling target.
- target2: Price for the second selling target.
- target3: Price for the third selling target.
- stop_loss: Recommended stop loss price.
- type: Type for this signal.
- ask: Current ask price when the signal was issued.
Please note that target2 and target3 may come with a zeroed value, meaning there’s not second and/or third target.
We hope you manage to use our API with the information contained on this page. If you need any help, feel free to contact our support staff through the email address support@cryptoqualitysignals.com or the Telegram address @CryptoQualitySignals
Thanks for supporting our services.