Skip to content

Update README.md #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
philsv merged 1 commit into from
Jul 7, 2025
Merged

Update README.md #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ pip install pycot-reports
## How to use

```python
from pycot.reports import CommitmentOfTraders
from pycot.reports import CommitmentsOfTraders

cot = CommitmentOfTraders("legacy_fut")
cot = CommitmentsOfTraders("legacy_fut")
df = cot.report(("FED FUNDS - CHICAGO BOARD OF TRADE", "30-DAY FEDERAL FUNDS - CHICAGO BOARD OF TRADE"))
```

Expand All @@ -35,9 +35,9 @@ If you want to retrieve data from the same report multiple times, you can use th
Lets have a look at an example:

```python
from pycot.reports import CommitmentOfTraders
from pycot.reports import CommitmentsOfTraders

cot = CommitmentOfTraders("legacy_fut")
cot = CommitmentsOfTraders("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"))
Expand All @@ -51,9 +51,9 @@ bbg_df = cot.report(("BBG COMMODITY - CHICAGO BOARD OF TRADE", "BLOOMBERG COMMOD
### Legacy Report (All Contracts)

```python
from pycot.reports import CommitmentOfTraders
from pycot.reports import CommitmentsOfTraders

cot = CommitmentOfTraders("legacy_fut")
cot = CommitmentsOfTraders("legacy_fut")
contract_names = ("FED FUNDS - CHICAGO BOARD OF TRADE", "30-DAY FEDERAL FUNDS - CHICAGO BOARD OF TRADE")
df = cot.report(contract_names)
```
Expand All @@ -80,9 +80,9 @@ Date ...
### Disaggregated Report (Commodities)

```python
from pycot.reports import CommitmentOfTraders
from pycot.reports import CommitmentsOfTraders

cot = CommitmentOfTraders("disaggregated_futopt")
cot = CommitmentsOfTraders("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)
```
Expand All @@ -109,9 +109,9 @@ Date .
### Financial Report (Financial Instruments)

```python
from pycot.reports import CommitmentOfTraders
from pycot.reports import CommitmentsOfTraders

cot = CommitmentOfTraders("traders_in_financial_futures_fut")
cot = CommitmentsOfTraders("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)
```
Expand All @@ -138,9 +138,9 @@ Date .
## List Available Contracts

```python
from pycot.reports import CommitmentOfTraders
from pycot.reports import CommitmentsOfTraders

cot = CommitmentOfTraders("legacy_fut")
cot = CommitmentsOfTraders("legacy_fut")
contracts: np.ndarray = cot.list_available_contracts()
```

Expand Down