​ The events API enables developers from any framework to send model events, logs, trades and notifications to the blankly platform for private, secure, but still sharable viewing & interaction. This is the missing frontend for developers who want to monetize their algorithms or investors that want to have a better view of how their money is used.

​ You can use these docs, or take advantage of one of our high-speed platform SDKs for your language.

Base URL

https://events.blankly.finance

V1

Authentication

Headers

Required

Optional

Lifecycle

Send the lifecycle of your model to the platform so you can easily see which models are running, pending or stopped.

POST /v1/model/lifecycle

Update the lifecycle of this particular model. This includes when the model starts & stops as well as if it's active & it's state. All keys here are optional, any key passed overrides the current value. Pass undefined or null values to each key to reset the status.

Monitoring

Post a wide variety of attributes of your model to the platform for a more complete & accurate view

POST /v1/model/used-symbol

POST /v1/model/used-exchange

Event

POST /v1/live/event

This is any generic event - generally a function call - to export to the platform. This will not be visualized on any chart but will be shown inside an event log.

Orders

POST /v1/live/spot-market

A basic market order done on a spot exchange (no leverage, margin, or shorting).The trade will be graphed for visualization & added to PNL calculation.

POST /v1/live/spot-limit

A basic limit order done on a spot exchange (no leverage, margin, or shorting).The trade will be graphed for visualization & added to PNL calculation.

POST /v1/live/spot-stop

A basic limit order done on a spot exchange (no leverage, margin, or shorting).The trade will be graphed for visualization & added to PNL calculation.

POST /v1/live/update-trade

Update an existing trade with any values relevant. This can include updating a limit or market order with the execution price or viewing the status of large and long term orders

POST /v1/live/update-annotation

Retroactively update an existing annotation or add a new one without sending along a full order body. This is extremely useful for changing contexts or giving better insights of how the algo views current orders.

Screener

POST /v1/live/screener-result

Run your model across symbols & markets to view inside the platform

{
  "result": {
    "AAPL": { // Organize by symbol
      "RSI": 29.5, // Keep the same keys internally across all symbols
      "buy_signal": true // Keep same keys
        },
    "MSFT": {
      "RSI": 54.3, // Nesting beyond this level is not supported
      "buy_signal": false
        }
  }
}

Logs

Send typed logs to the platform so you can monitor your model remotely

POST /v1/live/log

Backtests

Blankly supports viewing for multi symbol backtest orders, account values, metrics and custom events and indicator time series to make understanding, improving and sharing your model even easier.

POST /v1/backtest/result

Example

{
  "symbols": ["BTC-USD", "ETH-USD"], // A list of symbols used in the backtest
  "quote_asset": "USD", // The asset to quote from, what is you account value in?
  "start_time": 1577836800, // When the backtest started
  "stop_time": 1609459200, // When the backtest ended
  "backtest_id": "4j4n2399vh23kfjijk",
  "account_values": [ // The total value of the account over time
    {"time": 1613174400.0, "value": 10000.0},
    {"time": 1621209600.0, "value": 9952.061}
  ],
  "trades": [ // The trades that occured in the same format as the orders above
    {
      "symbol": "BTC-USD", 
      "size": 1.0,
      "side": "buy",
      "id": "009dad9b-b753-24d5-77d5-679e476b0277", 
      "time": 1609459200,
      "annotation": "RSI Low"
    }
  ],
  "metrics": { // Any single point metrics such as cagr
    "cagr": {
      "value": 14,
      "display_name": "Compound annual growth rate",
      "type": "percent"
    },
    "drawdown": {
      "value": 130.53,
      "display_name": "Drawdown",
      "type": "number"
    }
  },
  "indicators": { // Time series indicators used by your models for visualization
    "rsi": {
      "values": [
        {"time": 1613174400.0, "value": .52},
            {"time": 1621209600.0, "value": .53}
      ],
      "display_name": "Relative Strength Index",
      "type": "percent"
    }
  }
}

POST /v1/backtest/status

This route is used to specify the lifecycle of the current backtest runner.

{
  "successful": true,
  "status_summary": "Completed",
  "status_details": "",
  "time_elapsed": 5.3,
  "backtest_id": "4j4n2399vh23kfjijk"
}

POST /v1/backtest/log

Add a log specifically to this backtest

Base Routes

Generic API routes that require no authentication and are used for utility

Public

GET /time

Get server time in epoch seconds