NAV

Recent Changes 🕑

Feb 07, 2025

Base API Endpoint 🔗

Authentication 🔒

Must include API key in the header x-api-key for all requests.

Request Response

All requests follow typical HTTP response status codes for success, failure, and error.

Screener Alert

History List

Response Example:

{
  "items": [
    {
      "id": "ece8148a-5d09-4dbf-8fa3-d9f3de3a3459",
      "status": "CLOSED",
      "position": "SHORT",
      "exchange": "BINANCEFUTURES",
      "symbol": "SPXUSDT",
      "entryPrice": 0.7726,
      "takeProfitPrice": 0.70329395,
      "stoplossPrice": 0.79570202,
      "riskFactor": 2.5,
      "rewardFactor": 7.5,
      "telegramMessageId": 282,
      "updatedAt": "2025-02-05T22:49:53.059Z",
      "createdAt": "2025-02-05T18:49:24.067Z"
    },
    {
      "id": "7c5481d2-f225-40dd-ae15-3984ad34cb0f",
      "status": "PENDING",
      "position": "LONG",
      "exchange": "BINANCEFUTURES",
      "symbol": "VVVUSDT",
      "entryPrice": 5.372,
      "takeProfitPrice": 6.26571959,
      "stoplossPrice": 5.07409347,
      "riskFactor": 2.5,
      "rewardFactor": 7.5,
      "telegramMessageId": 288,
      "updatedAt": "2025-02-05T21:17:34.941Z",
      "createdAt": "2025-02-05T21:17:24.818Z"
    },
    {
      "id": "687553fb-8c24-4f4f-b0f5-cd232af3c7cf",
      "status": "PROFIT",
      "position": "LONG",
      "exchange": "BINANCEFUTURES",
      "symbol": "ENJUSDT",
      "entryPrice": 0.12074,
      "takeProfitPrice": 0.12994606,
      "stoplossPrice": 0.11767131,
      "riskFactor": 2.5,
      "rewardFactor": 7.5,
      "telegramMessageId": 286,
      "updatedAt": "2025-02-05T20:51:22.924Z",
      "createdAt": "2025-02-05T19:32:33.579Z"
    },
    {
      "id": "a4fdf966-d9a1-486c-87bc-eafd582d4446",
      "status": "STOPLOSS",
      "position": "LONG",
      "exchange": "BINANCEFUTURES",
      "symbol": "AI16ZUSDT",
      "entryPrice": 0.3427,
      "takeProfitPrice": 0.3870728,
      "stoplossPrice": 0.32790907,
      "riskFactor": 2.5,
      "rewardFactor": 7.5,
      "telegramMessageId": 276,
      "updatedAt": "2025-02-05T20:42:52.944Z",
      "createdAt": "2025-02-05T17:15:11.773Z"
    }
  ],
  "nextToken": null
}

This endpoint retrieves screener alert history.

HTTP Request

GET /v1/screener/alert/history

Request Header

Parameter Type Required Description
x-api-key String Yes API access key

Request Query

Parameter Type Default Required Description
status String - No Filter by status [OPEN, PENDING, CLOSED, PROFIT, STOPLOSS]
position String - No Filter by position [LONG, SHORT]
exchange String - No Filter by exchange.
symbol String - No Filter by exchange symbol.
sort String DESC No Sort by last update [DESC, ASC]
limit Integer 25 No Limit history list (Max: 100)
nextToken String - No Next pagination by token.

HTTP Response

Content-Type

application/json

Response Body Items

Parameter Type Description
id String (UUID) alert ID
status String [OPEN, PENDING, CLOSED, PROFIT, STOPLOSS]
position String [LONG, SHORT]
exchange String alert exchange
symbol String alert exchange symbol
entryPrice Float alert entry price range start
takeProfitPrice Float alert take profit price range start
stoplossPrice Float alert stop loss price range start
riskFactor Float alert risk factor
rewardFactor Float alert reward factor
telegramMessageId Integer / null alert telegram message id for status closed reply message
updatedAt String (ISO8601) when alert is last updated
createdAt String (ISO8601) when alert is created

History Stats

Response Example:

{
  "totalCount": 4,
  "statusCount": {
    "PENDING": 1,
    "CLOSED": 1,
    "PROFIT": 1,
    "STOPLOSS": 1
  },
  "positionCount": {
    "LONG": 3,
    "SHORT": 1
  }
}

This endpoint retrieves screener alert history stats.

HTTP Request

GET /v1/screener/alert/history/stats

Request Header

Parameter Type Required Description
x-api-key String Yes API access key

Request Query

Parameter Type Default Required Description
period String DAILY No stats period [DAILY, WEEKLY, MONTHLY]
exchange String - No stats by exchange.

HTTP Response

Content-Type

application/json

Response Body

Parameter Type Description
totalCount Integer total alert count based on period
statusCount Object total alert status count based on period
positionCount Object total alert position count based on period

Errors

Response Example (400)

{
  "message": "Invalid Request"
}

Response Example (404)

{
  "message": "Route Not Found"
}

Response Example (500)

{
  "message": "Server Error"
}
Status Type Description
400 Bad Request Could not process the request due to an error in the content type, usually related to an invalid JSON format in the request body.
403 Forbidden Could not authenticate the API key provided.
404 Not Found Could not find the resource or page.
422 Not Acceptable Could not process the request due to invalid body parameters or semantic errors.
500 Server Error Could not process the request due to an error, or the server may be temporarily unavailable due to technical issues.