data

Skip to API reference -->

See Examples in Code

Data

data module allows you to draw datasets from Wealthsimple Trade endpoints that may be useful for your business logic, including:

• Exchange rates for USD/CAD
• Extensive information about securities offered on the platform

This module is currently limited, but has lots of room for growth in later versions.

Note: All operations in data module require talking to Wealthsimple Trade endpoints. So make sure you are authenticated through the auth module.

API Reference

• data.exchangeRates

• data.getSecurity

• data.securityGroups

• data.getSecurityGroup

---

data.exchangeRates

A snapshot of the current USD/CAD exchange rates on the Wealthsimple Trade platform.

View examples

data.exchangeRates() -> Promise<any>

{
  USD: {
    buy_rate: 1.3009,
    sell_rate: 1.2621,
    spread: 0.015,
    fx_rate: 1.2814
  }
}

---

data.getSecurity

Information about a security on the Wealthsimple Trade Platform.

• ticker is an identifier for a security. Read this document to learn how to construct a valid ticker.
• extensive is a boolean that triggers a more detailed information draw, including the quote of the security.

Note: If extensive is set to true and you have enabled the securities cache, the securities cache is always bypassed and an API call is made. This is because the extensive data draw retrieves information like the quote.

View examples

data.getSecurity(ticker, [extensive]) -> Promise<any>

* This is not the full returned object - it has been cut.
{
  currency: 'USD',
  security_type: 'equity',
  ws_trade_eligible: true,
  cds_eligible: true,
  active_date: '1980-12-12',
  inactive_date: null,
  active: true,
  buyable: true,
  sellable: true,
  groups: [],
  status: 'trading',
  stock: {
    allowed_account_types: [ ... ],
    ...
  },
  allowed_order_subtypes: [ 'market', 'limit', 'stop_limit' ],
  ...
}

See also: config

---

data.securityGroups

Fetches a mapping of all security groups (available on the Trade platform) to their group ids.

View examples

data.securityGroups() -> Promise<any>

* This is not the full returned object - it has been cut.
{
  'Advertising and Marketing': 'security-group-010002a8af5d',
  Food: 'security-group-04a1061cb748',
  Telecommunications: 'security-group-10a243524442',
  Restaurants: 'security-group-131ff35963d0',
  Mobile: 'security-group-219397c25933',
  Education: 'security-group-261dd615edf2',
  Energy: 'security-group-2f8afc413e03',
  ...
}

---

data.getSecurityGroup

Retrieves all securities associated with the group name or id.

• If you provide the group name, we will automatically do a lookup from the Trade servers to get its identifier.
• Alternatively, You can get a list of all groups (with their group ids) from data.securityGroups and provide the group identifier directly.

View examples

data.getSecurityGroup(group) -> Promise<Array<any>>

* This is not the full returned object - it has been cut.
[
  {
    object: 'security',
    created_at: '2021-04-02T00:17:50.792Z',
    updated_at: '2021-04-02T00:17:50.792Z',
    security_id: 'sec-s-ab520260cddc422eade8bb0f76823a76',
    security_group_id: 'security-group-c6153b067083',
    filter_type: 'most_watched',
    ...
  },
  {
    object: 'security',
    created_at: '2021-04-02T00:17:50.792Z',
    updated_at: '2021-04-02T00:17:50.792Z',
    security_id: 'sec-s-ab520260cddc422eade8bb0f76823a76',
    security_group_id: 'security-group-c6153b067083',
    filter_type: 'most_watched',
    ...
  },
  ...
}

See also: data.securityGroups