User specific statistics

As a user, I should be able to know how many alerts I have received.

This endpoint returns the amount of alerts received, by markets, by final status.

It can also filter by date.

GET https://api.tradingpartners.ai/api/v1/alerts/statistics?to=2020-01-01T00:00:00Z&from=2020-01-02T00:00:00Z

Request Query Parameters

from - string fmt:date-time The start date in ISO 8601 format.

to - string fmt:date-time
The end date in ISO 8601 format.

ticker - string
Ticker concerned by the alert.
The filtering is case-insensitive & partial match.

instrument - string enum
Markets of the alert
The filtering is case-sensitive & complete match.
  • CRYPTOCURRENCIES
  • FOREX
  • INDICES
  • COMMODITIES
  • FUTURES
  • STOCKS
  • ETFS
status - string enum
Status of the alert
The filtering is case-sensitive & complete match.
  • ONMARK
  • ONGOING
  • WON
  • LOST
  • ABORTED

Statistics response object

Attributes

commodities - object
Statistics of commodities markets

aborted - number fmt:float64
Amount of invalidated commodities alerts.
See the different alerts states for more information.

lost - number fmt:float64
Amount of lost commodities alerts.

total - number fmt:float64
Amount of commodities alerts.

won - number fmt:float64
Amount of won commodities alerts.

crypto - object
Statistics of cryptocurrencies markets

aborted - number fmt:float64
Amount of invalidated cryptocurrencies alerts.
See the different alerts states for more information.

lost - number fmt:float64
Amount of lost cryptocurrencies alerts.

total - number fmt:float64
Amount of cryptocurrencies alerts.

won - number fmt:float64
Amount of won cryptocurrencies alerts.

forex - object
Statistics of forex markets

aborted - number fmt:float64
Amount of invalidated forex alerts.
See the different alerts states for more information.

lost - number fmt:float64
Amount of lost forex alerts.

total - number fmt:float64
Amount of forex alerts.

won - number fmt:float64
Amount of won forex alerts.

futures - object
Statistics of futures markets

aborted - number fmt:float64
Amount of invalidated futures alerts.
See the different alerts states for more information.

lost - number fmt:float64
Amount of lost futures alerts.

total - number fmt:float64
Amount of futures alerts.

won - number fmt:float64
Amount of won futures alerts.

indices - object
Statistics of indices markets

aborted - number fmt:float64
Amount of invalidated indices alerts.
See the different alerts states for more information.

lost - number fmt:float64
Amount of lost indices alerts.

total - number fmt:float64
Amount of indices alerts.

won - number fmt:float64
Amount of won indices alerts.

stocks - object
Statistics of stocks markets

aborted - number fmt:float64
Amount of invalidated stocks alerts.
See the different alerts states for more information.

lost - number fmt:float64
Amount of lost stocks alerts.

total - number fmt:float64
Amount of stocks alerts.

won - number fmt:float64
Amount of won stocks alerts.

Statistics object

{
  "commodities": {
    "aborted": 0,
    "lost": 1,
    "total": 4,
    "won": 3
  },
  "crypto": {
    "aborted": 186,
    "lost": 194,
    "total": 582,
    "won": 202
  },
  "forex": {
    "aborted": 0,
    "lost": 8,
    "total": 34,
    "won": 26
  },
  "futures": {
    "aborted": 246,
    "lost": 98,
    "total": 498,
    "won": 154
  },
  "indices": {
    "aborted": 11,
    "lost": 20,
    "total": 54,
    "won": 23
  },
  "stocks": {
    "aborted": 0,
    "lost": 36,
    "total": 211,
    "won": 175
  }
}