# pycot
[](https://badge.fury.io/py/pycot-reports)
[](https://github.com/philsv/pycot/blob/main/LICENSE)
[](https://pepy.tech/project/pycot-reports)
[](https://pepy.tech/project/pycot-reports)
[](https://pepy.tech/project/pycot-reports)
pycot is a easy to use python library for interacting with the [CFTC Commitment of Traders](https://www.cftc.gov/MarketReports/CommitmentsofTraders/index.htm) reports.
## Installation
```ini
pip install pycot-reports
```
## Requirements
* pandas
* requests
## How to use
```python
from pycot.reports import CommitmentOfTraders
cot = CommitmentOfTraders("legacy_fut")
df = cot.report(("FED FUNDS - CHICAGO BOARD OF TRADE", "30-DAY FEDERAL FUNDS - CHICAGO BOARD OF TRADE"))
```
## How do I get cached results?
If you want to retrieve data from the same report multiple times, you can use the `report` function. This will cache the results of the previous function call.
Lets have a look at an example:
```python
from pycot.reports import CommitmentOfTraders
cot = CommitmentOfTraders("legacy_fut")
# will load the full report (~ 10-20 seconds)
fed_funds_df = cot.report(("FED FUNDS - CHICAGO BOARD OF TRADE", "30-DAY FEDERAL FUNDS - CHICAGO BOARD OF TRADE"))
# cached, will load instantly
bbg_df = cot.report(("BBG COMMODITY - CHICAGO BOARD OF TRADE", "BLOOMBERG COMMODITY INDEX - CHICAGO BOARD OF TRADE"))
```
## Report Types
### Legacy Report (All Contracts)
```python
from pycot.reports import CommitmentOfTraders
cot = CommitmentOfTraders("legacy_fut")
contract_names = ("FED FUNDS - CHICAGO BOARD OF TRADE", "30-DAY FEDERAL FUNDS - CHICAGO BOARD OF TRADE")
df = cot.report(contract_names)
```
Output Example:
```ini
Contract Name Open Interest ... Net Change, Large Spec Net % of OI, Large Spec
Date ...
2023-07-11 FED FUNDS - CHICAGO BOARD OF TRADE 1440370.0 ... -58101.0 -11.5
2023-07-03 FED FUNDS - CHICAGO BOARD OF TRADE 1414525.0 ... -17553.0 -7.5
2023-06-27 FED FUNDS - CHICAGO BOARD OF TRADE 1746984.0 ... 12437.0 -5.1
2023-06-20 FED FUNDS - CHICAGO BOARD OF TRADE 1693141.0 ... 84512.0 -6.0
2023-06-13 FED FUNDS - CHICAGO BOARD OF TRADE 1556681.0 ... 60704.0 -12.0
... ... ... ... ... ...
1993-03-23 30-DAY FEDERAL FUNDS - CHICAGO BOARD OF TRADE 11298.0 ... 106.0 9.1
1993-03-16 30-DAY FEDERAL FUNDS - CHICAGO BOARD OF TRADE 11015.0 ... -8.0 8.3
1993-03-09 30-DAY FEDERAL FUNDS - CHICAGO BOARD OF TRADE 10651.0 ... -51.0 8.8
1993-03-02 30-DAY FEDERAL FUNDS - CHICAGO BOARD OF TRADE 10902.0 ... -190.0 9.0
1993-02-23 30-DAY FEDERAL FUNDS - CHICAGO BOARD OF TRADE 12460.0 ... -83.0 9.4
...
```
### Disaggregated Report (Commodities)
```python
from pycot.reports import CommitmentOfTraders
cot = CommitmentOfTraders("disaggregated_futopt")
contract_names = ("BRENT LAST DAY - NEW YORK MERCANTILE EXCHANGE", "BRENT CRUDE OIL LAST DAY - NEW YORK MERCANTILE EXCHANGE")
df = cot.report(contract_names)
```
Output Example:
```ini
Contract Name Open Interest ... Net Change Managed Money Net % of OI Managed Money
Date ...
2023-07-11 BRENT LAST DAY - NEW YORK MERCANTILE EXCHANGE 138358.0 ... -2134.0 -2.9
2023-07-03 BRENT LAST DAY - NEW YORK MERCANTILE EXCHANGE 130715.0 ... 9436.0 -1.4
2023-06-27 BRENT LAST DAY - NEW YORK MERCANTILE EXCHANGE 153190.0 ... -6135.0 -7.4
2023-06-20 BRENT LAST DAY - NEW YORK MERCANTILE EXCHANGE 148800.0 ... 2367.0 -3.5
2023-06-13 BRENT LAST DAY - NEW YORK MERCANTILE EXCHANGE 147598.0 ... -3872.0 -5.1
... ... ... ... ...
2011-04-12 BRENT CRUDE OIL LAST DAY - NEW YORK MERCANTILE... 20546.0 ... -484.0 17.1
2011-04-05 BRENT CRUDE OIL LAST DAY - NEW YORK MERCANTILE... 19533.0 ... 655.0 20.4
2011-03-29 BRENT CRUDE OIL LAST DAY - NEW YORK MERCANTILE... 18178.0 ... -276.0 18.4
2011-03-15 BRENT CRUDE OIL LAST DAY - NEW YORK MERCANTILE... 20233.0 ... 231.0 17.9
2011-03-08 BRENT CRUDE OIL LAST DAY - NEW YORK MERCANTILE... 19639.0 ... NaN 17.3
...
```
### Financial Report (Financial Instruments)
```python
from pycot.reports import CommitmentOfTraders
cot = CommitmentOfTraders("traders_in_financial_futures_fut")
contract_names = ("UST 10Y NOTE - CHICAGO BOARD OF TRADE", "10-YEAR U.S. TREASURY NOTES - CHICAGO BOARD OF TRADE", "10 YEAR U.S. TREASURY NOTES - CHICAGO BOARD OF TRADE")
df = cot.report(contract_names)
```
Output Example:
```ini
Contract Name Open Interest ... Net Change Lev Money Net % of OI Lev Money
Date ...
2023-07-11 UST 10Y NOTE - CHICAGO BOARD OF TRADE 4800091.0 ... 155532.0 -26.8
2023-07-03 UST 10Y NOTE - CHICAGO BOARD OF TRADE 4737762.0 ... 7710.0 -30.4
2023-06-27 UST 10Y NOTE - CHICAGO BOARD OF TRADE 4663919.0 ... -51457.0 -31.1
2023-06-20 UST 10Y NOTE - CHICAGO BOARD OF TRADE 4641767.0 ... -53136.0 -30.2
2023-06-13 UST 10Y NOTE - CHICAGO BOARD OF TRADE 4619668.0 ... 69602.0 -29.1
... ... ... ... ... ...
2006-07-11 10-YEAR U.S. TREASURY NOTES - CHICAGO BOARD OF... 2112145.0 ... 28199.0 1.8
2006-07-03 10-YEAR U.S. TREASURY NOTES - CHICAGO BOARD OF... 2136459.0 ... -18122.0 0.5
2006-06-27 10-YEAR U.S. TREASURY NOTES - CHICAGO BOARD OF... 2194364.0 ... 13929.0 1.3
2006-06-20 10-YEAR U.S. TREASURY NOTES - CHICAGO BOARD OF... 2097072.0 ... -27203.0 0.6
2006-06-13 10-YEAR U.S. TREASURY NOTES - CHICAGO BOARD OF... 1912279.0 ... NaN 2.2
...
```
## List Available Contracts
```python
from pycot.reports import CommitmentOfTraders
cot = CommitmentOfTraders("legacy_fut")
contracts: np.ndarray = cot.list_available_contracts()
```
Output Example:
```python
array(['1-MONTH SOFR - CHICAGO MERCANTILE EXCHANGE',
'10 YEAR DELIVERABLE IR - CHICAGO BOARD OF TRADE',
'10 YEAR DELIVERABLE IR SWAP - CHICAGO BOARD OF TRADE',
'10 YEAR ERIS SOFR SWAP - CHICAGO BOARD OF TRADE',
'10 YEAR ERIS SWAP - CHICAGO BOARD OF TRADE',
'10-YEAR U.S. TREASURY NOTES - CHICAGO BOARD OF TRADE',
...
'UST 10Y NOTE - CHICAGO BOARD OF TRADE',
'UST 2Y NOTE - CHICAGO BOARD OF TRADE',
'UST 5Y NOTE - CHICAGO BOARD OF TRADE',
'UST BOND - CHICAGO BOARD OF TRADE',
'VIX FUTURES - CBOE FUTURES EXCHANGE'], dtype=object)
```
## Release Shedule
The CFTC [releases](https://www.cftc.gov/MarketReports/CommitmentsofTraders/ReleaseSchedule/index.htm) the reports every Friday at 3:30pm Eastern Time.
Raw data
{
"_id": null,
"home_page": "https://github.com/philsv/pycot",
"name": "pycot-reports",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "commitment of traders, cot data, cftc, python",
"author": "philsv",
"author_email": "frphsv@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0b/e2/67570fcd09a0574e9b3397d1027e3d9b37abe507c7f26c95a7d1f2d588bb/pycot-reports-0.1.2.tar.gz",
"platform": null,
"description": "# pycot\n\n[](https://badge.fury.io/py/pycot-reports)\n[](https://github.com/philsv/pycot/blob/main/LICENSE)\n[](https://pepy.tech/project/pycot-reports)\n[](https://pepy.tech/project/pycot-reports)\n[](https://pepy.tech/project/pycot-reports)\n\npycot is a easy to use python library for interacting with the [CFTC Commitment of Traders](https://www.cftc.gov/MarketReports/CommitmentsofTraders/index.htm) reports.\n\n## Installation\n\n```ini\npip install pycot-reports\n```\n\n## Requirements\n\n* pandas\n* requests\n\n## How to use\n\n```python\nfrom pycot.reports import CommitmentOfTraders\n\ncot = CommitmentOfTraders(\"legacy_fut\")\ndf = cot.report((\"FED FUNDS - CHICAGO BOARD OF TRADE\", \"30-DAY FEDERAL FUNDS - CHICAGO BOARD OF TRADE\"))\n```\n\n## How do I get cached results?\n\nIf you want to retrieve data from the same report multiple times, you can use the `report` function. This will cache the results of the previous function call.\n\nLets have a look at an example:\n\n```python\nfrom pycot.reports import CommitmentOfTraders\n\ncot = CommitmentOfTraders(\"legacy_fut\")\n\n# will load the full report (~ 10-20 seconds)\nfed_funds_df = cot.report((\"FED FUNDS - CHICAGO BOARD OF TRADE\", \"30-DAY FEDERAL FUNDS - CHICAGO BOARD OF TRADE\"))\n\n# cached, will load instantly\nbbg_df = cot.report((\"BBG COMMODITY - CHICAGO BOARD OF TRADE\", \"BLOOMBERG COMMODITY INDEX - CHICAGO BOARD OF TRADE\"))\n```\n\n## Report Types\n\n### Legacy Report (All Contracts)\n\n```python\nfrom pycot.reports import CommitmentOfTraders\n\ncot = CommitmentOfTraders(\"legacy_fut\")\ncontract_names = (\"FED FUNDS - CHICAGO BOARD OF TRADE\", \"30-DAY FEDERAL FUNDS - CHICAGO BOARD OF TRADE\")\ndf = cot.report(contract_names)\n```\n\nOutput Example:\n\n```ini\n Contract Name Open Interest ... Net Change, Large Spec Net % of OI, Large Spec\nDate ... \n2023-07-11 FED FUNDS - CHICAGO BOARD OF TRADE 1440370.0 ... -58101.0 -11.5\n2023-07-03 FED FUNDS - CHICAGO BOARD OF TRADE 1414525.0 ... -17553.0 -7.5\n2023-06-27 FED FUNDS - CHICAGO BOARD OF TRADE 1746984.0 ... 12437.0 -5.1\n2023-06-20 FED FUNDS - CHICAGO BOARD OF TRADE 1693141.0 ... 84512.0 -6.0\n2023-06-13 FED FUNDS - CHICAGO BOARD OF TRADE 1556681.0 ... 60704.0 -12.0\n... ... ... ... ... ...\n1993-03-23 30-DAY FEDERAL FUNDS - CHICAGO BOARD OF TRADE 11298.0 ... 106.0 9.1\n1993-03-16 30-DAY FEDERAL FUNDS - CHICAGO BOARD OF TRADE 11015.0 ... -8.0 8.3\n1993-03-09 30-DAY FEDERAL FUNDS - CHICAGO BOARD OF TRADE 10651.0 ... -51.0 8.8\n1993-03-02 30-DAY FEDERAL FUNDS - CHICAGO BOARD OF TRADE 10902.0 ... -190.0 9.0\n1993-02-23 30-DAY FEDERAL FUNDS - CHICAGO BOARD OF TRADE 12460.0 ... -83.0 9.4\n...\n```\n\n### Disaggregated Report (Commodities)\n\n```python\nfrom pycot.reports import CommitmentOfTraders\n\ncot = CommitmentOfTraders(\"disaggregated_futopt\")\ncontract_names = (\"BRENT LAST DAY - NEW YORK MERCANTILE EXCHANGE\", \"BRENT CRUDE OIL LAST DAY - NEW YORK MERCANTILE EXCHANGE\")\ndf = cot.report(contract_names)\n```\n\nOutput Example:\n\n```ini\n Contract Name Open Interest ... Net Change Managed Money Net % of OI Managed Money\nDate ... \n2023-07-11 BRENT LAST DAY - NEW YORK MERCANTILE EXCHANGE 138358.0 ... -2134.0 -2.9\n2023-07-03 BRENT LAST DAY - NEW YORK MERCANTILE EXCHANGE 130715.0 ... 9436.0 -1.4\n2023-06-27 BRENT LAST DAY - NEW YORK MERCANTILE EXCHANGE 153190.0 ... -6135.0 -7.4\n2023-06-20 BRENT LAST DAY - NEW YORK MERCANTILE EXCHANGE 148800.0 ... 2367.0 -3.5\n2023-06-13 BRENT LAST DAY - NEW YORK MERCANTILE EXCHANGE 147598.0 ... -3872.0 -5.1\n... ... ... ... ...\n2011-04-12 BRENT CRUDE OIL LAST DAY - NEW YORK MERCANTILE... 20546.0 ... -484.0 17.1\n2011-04-05 BRENT CRUDE OIL LAST DAY - NEW YORK MERCANTILE... 19533.0 ... 655.0 20.4\n2011-03-29 BRENT CRUDE OIL LAST DAY - NEW YORK MERCANTILE... 18178.0 ... -276.0 18.4\n2011-03-15 BRENT CRUDE OIL LAST DAY - NEW YORK MERCANTILE... 20233.0 ... 231.0 17.9\n2011-03-08 BRENT CRUDE OIL LAST DAY - NEW YORK MERCANTILE... 19639.0 ... NaN 17.3\n...\n```\n\n### Financial Report (Financial Instruments)\n\n```python\nfrom pycot.reports import CommitmentOfTraders\n\ncot = CommitmentOfTraders(\"traders_in_financial_futures_fut\")\ncontract_names = (\"UST 10Y NOTE - CHICAGO BOARD OF TRADE\", \"10-YEAR U.S. TREASURY NOTES - CHICAGO BOARD OF TRADE\", \"10 YEAR U.S. TREASURY NOTES - CHICAGO BOARD OF TRADE\")\ndf = cot.report(contract_names)\n```\n\nOutput Example:\n\n```ini\n Contract Name Open Interest ... Net Change Lev Money Net % of OI Lev Money\nDate ... \n2023-07-11 UST 10Y NOTE - CHICAGO BOARD OF TRADE 4800091.0 ... 155532.0 -26.8\n2023-07-03 UST 10Y NOTE - CHICAGO BOARD OF TRADE 4737762.0 ... 7710.0 -30.4\n2023-06-27 UST 10Y NOTE - CHICAGO BOARD OF TRADE 4663919.0 ... -51457.0 -31.1\n2023-06-20 UST 10Y NOTE - CHICAGO BOARD OF TRADE 4641767.0 ... -53136.0 -30.2\n2023-06-13 UST 10Y NOTE - CHICAGO BOARD OF TRADE 4619668.0 ... 69602.0 -29.1\n... ... ... ... ... ...\n2006-07-11 10-YEAR U.S. TREASURY NOTES - CHICAGO BOARD OF... 2112145.0 ... 28199.0 1.8\n2006-07-03 10-YEAR U.S. TREASURY NOTES - CHICAGO BOARD OF... 2136459.0 ... -18122.0 0.5\n2006-06-27 10-YEAR U.S. TREASURY NOTES - CHICAGO BOARD OF... 2194364.0 ... 13929.0 1.3\n2006-06-20 10-YEAR U.S. TREASURY NOTES - CHICAGO BOARD OF... 2097072.0 ... -27203.0 0.6\n2006-06-13 10-YEAR U.S. TREASURY NOTES - CHICAGO BOARD OF... 1912279.0 ... NaN 2.2\n...\n```\n\n## List Available Contracts\n\n```python\nfrom pycot.reports import CommitmentOfTraders\n\ncot = CommitmentOfTraders(\"legacy_fut\")\ncontracts: np.ndarray = cot.list_available_contracts()\n```\n\nOutput Example:\n\n```python\narray(['1-MONTH SOFR - CHICAGO MERCANTILE EXCHANGE',\n '10 YEAR DELIVERABLE IR - CHICAGO BOARD OF TRADE',\n '10 YEAR DELIVERABLE IR SWAP - CHICAGO BOARD OF TRADE',\n '10 YEAR ERIS SOFR SWAP - CHICAGO BOARD OF TRADE',\n '10 YEAR ERIS SWAP - CHICAGO BOARD OF TRADE',\n '10-YEAR U.S. TREASURY NOTES - CHICAGO BOARD OF TRADE',\n ...\n 'UST 10Y NOTE - CHICAGO BOARD OF TRADE',\n 'UST 2Y NOTE - CHICAGO BOARD OF TRADE',\n 'UST 5Y NOTE - CHICAGO BOARD OF TRADE',\n 'UST BOND - CHICAGO BOARD OF TRADE',\n 'VIX FUTURES - CBOE FUTURES EXCHANGE'], dtype=object)\n```\n\n## Release Shedule\n\nThe CFTC [releases](https://www.cftc.gov/MarketReports/CommitmentsofTraders/ReleaseSchedule/index.htm) the reports every Friday at 3:30pm Eastern Time.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python Library for interacting with the CFTC Commitment of Traders reports.",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/philsv/pycot"
},
"split_keywords": [
"commitment of traders",
" cot data",
" cftc",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "828625248240412875323e0782b153d985d0d0da66eb83a3bca9247a8bb84fda",
"md5": "50c4b13af638a1c29710340c4efacf2a",
"sha256": "2c1481aa78000f81a84dfa0b1e6ad5164f71cd7f60650c7e096ba500fb44f56f"
},
"downloads": -1,
"filename": "pycot_reports-0.1.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "50c4b13af638a1c29710340c4efacf2a",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 12479,
"upload_time": "2024-08-25T21:46:26",
"upload_time_iso_8601": "2024-08-25T21:46:26.980643Z",
"url": "https://files.pythonhosted.org/packages/82/86/25248240412875323e0782b153d985d0d0da66eb83a3bca9247a8bb84fda/pycot_reports-0.1.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0be267570fcd09a0574e9b3397d1027e3d9b37abe507c7f26c95a7d1f2d588bb",
"md5": "50abfa4d750e37555dd01095588d6b39",
"sha256": "78dca22b796fc6e301360fdf8456519a9e1e4df494b2666c5543b68778c0aad0"
},
"downloads": -1,
"filename": "pycot-reports-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "50abfa4d750e37555dd01095588d6b39",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10656,
"upload_time": "2024-08-25T21:46:28",
"upload_time_iso_8601": "2024-08-25T21:46:28.067370Z",
"url": "https://files.pythonhosted.org/packages/0b/e2/67570fcd09a0574e9b3397d1027e3d9b37abe507c7f26c95a7d1f2d588bb/pycot-reports-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-25 21:46:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "philsv",
"github_project": "pycot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pandas",
"specs": [
[
">=",
"1.5.3"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.26.0"
]
]
}
],
"lcname": "pycot-reports"
}
JSON
