TAtatum
Subscriptions

Get alert by ID

/v4/subscription/{id}

Get alert by ID.

get/v4/subscription/{id}

Request

  • Base URL
    https://api.tatum.io
  • URL
    https://api.tatum.io/v4/subscription/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required
Example:5e68c66581f2ee32bc354087

Alert ID

Response

OK

type'ADDRESS_EVENT' | 'CONTRACT_ADDRESS_LOG_EVENT' | 'INCOMING_NATIVE_TX' | 'OUTGOING_NATIVE_TX' | 'OUTGOING_FAILED_TX' | 'PAID_FEE' | 'INCOMING_INTERNAL_TX' | 'OUTGOING_INTERNAL_TX' | 'INCOMING_FUNGIBLE_TX' | 'OUTGOING_FUNGIBLE_TX' | 'INCOMING_NFT_TX' | 'OUTGOING_NFT_TX' | 'INCOMING_MULTITOKEN_TX' | 'OUTGOING_MULTITOKEN_TX' | 'MINT_TX' | 'BURN_TX' | 'SWAP_TX' | 'FAILED_TXS_PER_BLOCK' | 'PRICE_CHANGE' required

Type of the alert.

idstring required

ID of the alert

timestampnumber

Alert creation time

referencePricestring

PRICE_CHANGE only: what the next move is measured from. atPrice — the watched level; pctChange with 1m — the price at creation, or for RECURRING alerts the price at the last fire; pctChange with 1h/1d/1w — the current candle's opening price.

periodStartnumber

PRICE_CHANGE with candleTimeFrame 1h/1d/1w only: start (milliseconds, UTC) of the candle the current reference price belongs to.

status'ACTIVE' | 'PAUSED' | 'TRIGGERED'

PRICE_CHANGE only: lifecycle state. TRIGGERED — a ONE_TIME alert that has already fired; terminal and immutable.

pausednumber

PRICE_CHANGE only: timestamp (ms) since when the alert is paused.

triggeredAtnumber

PRICE_CHANGE only: timestamp (ms) when a ONE_TIME alert fired.

notestring

Any other relevant information such as important updates

Example response

{
  "type": "ADDRESS_EVENT",
  "id": "7c21ed165e294db78b95f0f1",
  "timestamp": 1653320900353,
  "attr": {
    "chain": "ethereum-mainnet",
    "symbol": "BTC",
    "frequency": "RECURRING",
    "direction": "BOTH",
    "alertCondition": {
      "atPrice": 110000
    }
  },
  "referencePrice": "100000",
  "periodStart": 1784678400000
}

Changes

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