API Reference

Introduction

Welcome to the CoinSignal API documentation. This API allows you to programmatically access the latest trading signals and market news summaries generated by our bot.

Integrating our signals can help power your own trading applications, analysis tools, or automated systems.

Authentication

To access the API endpoints, you need an API key. You can generate and manage your API keys on your dedicated .

Include your API key in the X-API-KEY HTTP header for every request you make to authenticated endpoints.

Example Header:

X-API-KEY: YOUR_API_KEY_HERE

Rate Limits

API access is subject to rate limits to ensure fair usage and service stability. Limits are applied per API key or by IP address if no key is provided.

Current limits for data endpoints (/signal, /news) are:

60 requests per minute
600 requests per hour

Requests exceeding the rate limit will receive a 429 Too Many Requests response.

Endpoints

GET /signal

Retrieves the latest trading signal and justification for a specified cryptocurrency.

Parameters:

currency (string, optional, default: BTC): The cryptocurrency ticker (e.g., BTC, ETH).

Example Request (cURL):

curl -X GET \
  'https://api.coinsignal.app/signal?currency=ETH' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Example Response (JSON):

{
  "signal": "BUY",
  "justification": "**RSI is showing potential undervaluation.** EMA 21/34/144 indicate upward trend, while 500 EMA acts as long-term support...",
  "justification_short": "Market shows BUY potential due to RSI undervaluation and bullish EMA cross.",
  "timestamp": "2023-10-27 10:00:00",
  "currency": "ETH",
  "signal_strength": 4,
  "status": "Success"
}

Response Fields:

signal (string): The trading signal (BUY, HOLD, or SELL).
justification (string): A detailed analysis supporting the signal.
justification_short (string): A concise summary of the justification.
timestamp (string): UTC timestamp of the signal generation (YYYY-MM-DD HH:MM:SS).
currency (string): The cryptocurrency ticker the signal is for.
signal_strength (integer): How many of the last 5 signals for this currency match the current signal (1-5).
status (string): Indicates success or error.

Note: Error responses will contain { "status": "error", "message": "..." }

GET /news

Retrieves the latest market sentiment summary based on recent news.

Parameters:

None.

Example Request (cURL):

curl -X GET \
  'https://api.coinsignal.app/news' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Example Response (JSON):

{
  "summary": "Crypto market sentiment is cautiously bullish. Positive news around institutional adoption and ETF progress is driving momentum, though regulatory uncertainties remain a concern.",
  "timestamp": "2023-10-27 10:00:00"
}

Response Fields:

summary (string): A concise summary of the latest market sentiment derived from news.
timestamp (string): UTC timestamp when the news summary was generated (YYYY-MM-DD HH:MM:SS).

Note: A 404 Not Found response will be returned if no news entries are available.

Error responses will contain { "status": "error", "message": "..." }