| Name | openbb-tmx JSON |
| Version |
1.4.0
JSON |
| download |
| home_page | None |
| Summary | Unofficial TMX data provider extension for the OpenBB Platform - Public Canadian markets data for Python and Fast API. |
| upload_time | 2025-10-08 16:37:09 |
| maintainer | None |
| docs_url | None |
| author | OpenBB |
| requires_python | <3.14,>=3.9.21 |
| license | AGPL-3.0-only |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# OpenBB TMX Provider
This extension integrates the [TMX](https://www.tmx.com) data provider into the OpenBB Platform.
## Installation
To install the extension:
```bash
pip install openbb-tmx
```
Documentation available [here](https://docs.openbb.co/platform/developer_guide/contributing).
## Additional information
`openbb-tmx` is an unofficial, community, data provider extension for the OpenBB Platform.
Install with `pip install openbb-tmx`, or from the local directory, `pip install -e .`
## Command Coverage
- .derivatives.options.chains
- Historical EOD chains data available from 2009.
- .equity.calendar.earnings
- .equity.estimates.consensus
- .equity.discovery.gainers
- Includes a 'category' parameter for the type of 'best performer'.
- .equity.fundamental.dividends
- .equity.fundamental.filings
- .equity.ownership.insider_trading
- Does not use the Standard Model because the data returned are total shares traded over the previous 3,6,and 12 months.
- .equity.price.quote
- .equity.price.historical
- Daily, weekly, monthly, and intraday - with valid intervals being any X number of minutes.
- Weekly and monthly intervals are for the period beginning.
- Historical intraday data begins April 14, 2022.
- Split-adjusted, split and dividend adjusted, as well as unadjusted prices are available only for daily intervals. Other intervals are split-adjusted.
- .equity.search
- .equity.profile
- .etf.search
- .etf.info
- .etf.sectors
- .etf.countries
- .etf.holdings
- Top 10 holdings only.
- .fixedincome.corporate.bond_prices
- .fixedincome.government.treasury_prices
- .index.constituents
- Full constituents with weights and notional values.
- .index.snapshots
- Regions of: ["ca", "us"]
- .index.available
- Includes URLs to methedology and factsheet documents.
- .index.sectors
- .news.company
## Symbology
No exchange suffix is required to handle Canadian listings. The extension accepts `.TO` and `.TSX` as well as no suffix. Additionally, a composite ticker symbol can be entered. For example, `AAPL` trades as a Canadian Depositary Receipt, under the symbol `AAPL:AQN`, on the NEO Exchange. The US listing is also found as `AAPL:US`. Some US and select European data is available from some functions, like `quote` and `historical`.
Indices all begin with `^`.
## Caching
This extension uses `aiohttp-client-cache` with a SQL backend to cache symbol directories, ETF, and index data. It can be bypassed with the parameter, `use_cache=False`. ETF and index data is gathered from a single JSON file which is updated daily by the exchange. The HTTP request is cached for one day.
Raw data
{
"_id": null,
"home_page": null,
"name": "openbb-tmx",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.9.21",
"maintainer_email": null,
"keywords": null,
"author": "OpenBB",
"author_email": "hello@openbb.co",
"download_url": "https://files.pythonhosted.org/packages/2a/e0/e5c244e4cd02c2729439c7f2434a40295d5940abcaef5b0928203ac1a67e/openbb_tmx-1.4.0.tar.gz",
"platform": null,
"description": "# OpenBB TMX Provider\n\nThis extension integrates the [TMX](https://www.tmx.com) data provider into the OpenBB Platform.\n\n## Installation\n\nTo install the extension:\n\n```bash\npip install openbb-tmx\n```\n\nDocumentation available [here](https://docs.openbb.co/platform/developer_guide/contributing).\n\n## Additional information\n\n`openbb-tmx` is an unofficial, community, data provider extension for the OpenBB Platform.\n\nInstall with `pip install openbb-tmx`, or from the local directory, `pip install -e .`\n\n## Command Coverage\n\n- .derivatives.options.chains\n - Historical EOD chains data available from 2009.\n- .equity.calendar.earnings\n- .equity.estimates.consensus\n- .equity.discovery.gainers\n - Includes a 'category' parameter for the type of 'best performer'.\n- .equity.fundamental.dividends\n- .equity.fundamental.filings\n- .equity.ownership.insider_trading\n - Does not use the Standard Model because the data returned are total shares traded over the previous 3,6,and 12 months.\n- .equity.price.quote\n- .equity.price.historical\n - Daily, weekly, monthly, and intraday - with valid intervals being any X number of minutes.\n - Weekly and monthly intervals are for the period beginning.\n - Historical intraday data begins April 14, 2022.\n - Split-adjusted, split and dividend adjusted, as well as unadjusted prices are available only for daily intervals. Other intervals are split-adjusted.\n- .equity.search\n- .equity.profile\n- .etf.search\n- .etf.info\n- .etf.sectors\n- .etf.countries\n- .etf.holdings\n - Top 10 holdings only.\n- .fixedincome.corporate.bond_prices\n- .fixedincome.government.treasury_prices\n- .index.constituents\n - Full constituents with weights and notional values.\n- .index.snapshots\n - Regions of: [\"ca\", \"us\"]\n- .index.available\n - Includes URLs to methedology and factsheet documents.\n- .index.sectors\n- .news.company\n\n## Symbology\n\nNo exchange suffix is required to handle Canadian listings. The extension accepts `.TO` and `.TSX` as well as no suffix. Additionally, a composite ticker symbol can be entered. For example, `AAPL` trades as a Canadian Depositary Receipt, under the symbol `AAPL:AQN`, on the NEO Exchange. The US listing is also found as `AAPL:US`. Some US and select European data is available from some functions, like `quote` and `historical`.\n\nIndices all begin with `^`.\n\n## Caching\n\nThis extension uses `aiohttp-client-cache` with a SQL backend to cache symbol directories, ETF, and index data. It can be bypassed with the parameter, `use_cache=False`. ETF and index data is gathered from a single JSON file which is updated daily by the exchange. The HTTP request is cached for one day.\n",
"bugtrack_url": null,
"license": "AGPL-3.0-only",
"summary": "Unofficial TMX data provider extension for the OpenBB Platform - Public Canadian markets data for Python and Fast API.",
"version": "1.4.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "06c4031a062842dbe47f896f877bc5c03e0cdfd433072681aa8cc7e1c77c6e9a",
"md5": "31d03c17542c7c0c48d5468e4261d298",
"sha256": "d8b2148f1c112d51059b322238c4c786687e7b43ad7a9fb6889b967e793181bd"
},
"downloads": -1,
"filename": "openbb_tmx-1.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "31d03c17542c7c0c48d5468e4261d298",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.9.21",
"size": 60638,
"upload_time": "2025-10-08T16:37:08",
"upload_time_iso_8601": "2025-10-08T16:37:08.633839Z",
"url": "https://files.pythonhosted.org/packages/06/c4/031a062842dbe47f896f877bc5c03e0cdfd433072681aa8cc7e1c77c6e9a/openbb_tmx-1.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2ae0e5c244e4cd02c2729439c7f2434a40295d5940abcaef5b0928203ac1a67e",
"md5": "d018b11269ec5543b160e9f746b8068b",
"sha256": "21f28cb89e16f1b9e724dbeb6cc6163fb462e73e7d9e524183028713dee67374"
},
"downloads": -1,
"filename": "openbb_tmx-1.4.0.tar.gz",
"has_sig": false,
"md5_digest": "d018b11269ec5543b160e9f746b8068b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.9.21",
"size": 36082,
"upload_time": "2025-10-08T16:37:09",
"upload_time_iso_8601": "2025-10-08T16:37:09.539361Z",
"url": "https://files.pythonhosted.org/packages/2a/e0/e5c244e4cd02c2729439c7f2434a40295d5940abcaef5b0928203ac1a67e/openbb_tmx-1.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-08 16:37:09",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "openbb-tmx"
}
