formulas

post/api/v1/formulas

Request

  • Base URL: https://api.blackforge.so (the document declares no server; this is the origin it was published from)
  • URL: https://api.blackforge.so/api/v1/formulas
  • Auth: API key in header x-api-key

Request body

exprstring required

The formula source, e.g. mid(binance:BTCUSDT) - mid(okx:BTC-USDT). Trade and book-change terms cover the w seconds ending one second before the value's timestamp; book terms are read at the timestamp.

intervalnumber

Update interval in whole seconds, 1 to 60. Default 1.

namestring required

A name you choose, 1 to 80 characters.

ephemeralboolean

Keep it for one hour only, outside your saved-formula count. For "watch this for a minute".

Response

Saves a formula. Values are computed server-side every interval while it is streamed or behind an active notification, charged 1 row per referenced pair per evaluation. Trade and book-change terms cover the w seconds ending one second before the value's timestamp; book terms are read at the timestamp. Ultra only; any other plan gets 403 {"error":{"code":"plan_required","plan":"ultra","upgrade":"https://blackforge.so/pricing"}}.

Changes

No recorded changes to this operation across all 1 revision of this API.