Price Alerting API for digital portals

Overview

The endpoint group "basic price alerting" deals with generation of alerts based on current price data. For notations, users can define an upper or lower limit and choose on which price type those limit conditions apply.

The platform today already manages over 1.3 million active triggers with 300,000 real-time alerts delivered per day. See the Quotes API for Digital Portals for access to detailed price information.

API Definition

swagger_file_format

API Documentation

SDK Library

Code Snippet

Add trigger

This code snippet uses the JavaScript Client Library to create a new trigger.

export interface Trigger {
  type: 'bid' | 'ask' | 'trade';
  lowerLimit: number;
  upperLimit: number;
  comment: string;
}

  public async addTrigger(idNotation: string, trigger: Trigger): Promise {
    const body = {
      data: {
        notation: {id: idNotation},
        price: {
          type: trigger.type,
        },
        range: {
          lowerLimit: Number(trigger.lowerLimit),
          upperLimit: Number(trigger.upperLimit),
        },
        comment: trigger.comment,
      },
    };
    await this.client.requestEndpoint('POST', '/api/v1/alerting/prices/basic/trigger/create', body, {no_merge: true});
  }
Add trigger

This code snippet uses the JavaScript Client Library to create a new trigger.

export interface Trigger {
  type: 'bid' | 'ask' | 'trade';
  lowerLimit: number;
  upperLimit: number;
  comment: string;
}

  public async addTrigger(idNotation: string, trigger: Trigger): Promise {
    const body = {
      data: {
        notation: {id: idNotation},
        price: {
          type: trigger.type,
        },
        range: {
          lowerLimit: Number(trigger.lowerLimit),
          upperLimit: Number(trigger.upperLimit),
        },
        comment: trigger.comment,
      },
    };
    await this.client.requestEndpoint('POST', '/api/v1/alerting/prices/basic/trigger/create', body, {no_merge: true});
  }
Add trigger

This code snippet uses the JavaScript Client Library to create a new trigger.

export interface Trigger {
  type: 'bid' | 'ask' | 'trade';
  lowerLimit: number;
  upperLimit: number;
  comment: string;
}

  public async addTrigger(idNotation: string, trigger: Trigger): Promise {
    const body = {
      data: {
        notation: {id: idNotation},
        price: {
          type: trigger.type,
        },
        range: {
          lowerLimit: Number(trigger.lowerLimit),
          upperLimit: Number(trigger.upperLimit),
        },
        comment: trigger.comment,
      },
    };
    await this.client.requestEndpoint('POST', '/api/v1/alerting/prices/basic/trigger/create', body, {no_merge: true});
  }

Change Logs