Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
5d0e06b
Merge pull request #40 from MarketDataApp/dev
AhmedCoolProjects Jan 25, 2024
de45532
Merge pull request #41 from MarketDataApp/dev
MarketDataApp Jan 26, 2024
c5cf693
Merge pull request #42 from MarketDataApp/dev
AhmedCoolProjects Jan 26, 2024
1b4ecf6
Merge pull request #43 from MarketDataApp/dev
MarketDataApp Jan 26, 2024
05f61ab
Merge pull request #44 from MarketDataApp/dev
MarketDataApp Jan 27, 2024
8df58c4
Merge pull request #45 from MarketDataApp/dev
MarketDataApp Jan 27, 2024
8ac2f77
Merge pull request #46 from MarketDataApp/dev
MarketDataApp Jan 31, 2024
91cfb4b
Merge pull request #47 from MarketDataApp/dev
MarketDataApp Feb 2, 2024
659873b
Merge pull request #48 from MarketDataApp/dev
MarketDataApp Feb 2, 2024
3cec55e
Merge pull request #49 from MarketDataApp/dev
MarketDataApp Feb 2, 2024
0767a31
Merge pull request #50 from MarketDataApp/dev
MarketDataApp Feb 20, 2024
8b7711f
Merge pull request #51 from MarketDataApp/dev
MarketDataApp Feb 23, 2024
0883f57
Merge pull request #52 from MarketDataApp/dev
MarketDataApp Feb 23, 2024
2188ca8
Merge pull request #53 from MarketDataApp/dev
MarketDataApp Feb 26, 2024
97eb5ff
Merge pull request #54 from MarketDataApp/dev
MarketDataApp Feb 26, 2024
004cf4b
Merge pull request #55 from MarketDataApp/dev
MarketDataApp Feb 26, 2024
b73e40c
Merge pull request #56 from MarketDataApp/dev
MarketDataApp Mar 3, 2024
b1ca9ff
Merge pull request #57 from MarketDataApp/dev
MarketDataApp Mar 5, 2024
058374c
Merge pull request #58 from MarketDataApp/dev
MarketDataApp Mar 12, 2024
5a9be7c
Merge pull request #59 from MarketDataApp/dev
MarketDataApp Mar 26, 2024
5597046
Merge pull request #60 from MarketDataApp/dev
MarketDataApp Apr 22, 2024
626382c
Merge pull request #61 from MarketDataApp/dev
MarketDataApp Apr 22, 2024
0bf821a
Merge pull request #62 from MarketDataApp/dev
MarketDataApp Apr 24, 2024
7020a03
Merge pull request #63 from MarketDataApp/dev
MarketDataApp May 7, 2024
505c3a2
Merge pull request #64 from MarketDataApp/dev
MarketDataApp May 17, 2024
6a3927f
Merge pull request #65 from MarketDataApp/dev
MarketDataApp Jul 4, 2024
fae7d6d
Merge pull request #66 from MarketDataApp/dev
MarketDataApp Jul 9, 2024
e8f8392
Merge pull request #70 from MarketDataApp/dev
MarketDataApp Sep 6, 2024
868de71
Merge pull request #71 from MarketDataApp/dev
MarketDataApp Sep 9, 2024
64a2f46
Merge pull request #72 from MarketDataApp/dev
MarketDataApp Sep 17, 2024
f2dc78b
Merge pull request #73 from MarketDataApp/dev
MarketDataApp Sep 24, 2024
9a16b59
Merge pull request #75 from MarketDataApp/dev
MarketDataApp Oct 25, 2024
6efcd1a
Merge pull request #77 from MarketDataApp/dev
MarketDataApp Feb 12, 2025
47b4613
Merge pull request #78 from MarketDataApp/dev
MarketDataApp Mar 10, 2025
4e54ea6
Merge pull request #79 from MarketDataApp/dev
MarketDataApp Mar 11, 2025
d105005
Merge pull request #80 from MarketDataApp/dev
MarketDataApp Mar 19, 2025
7dd9397
Merge pull request #81 from MarketDataApp/dev
MarketDataApp Apr 3, 2025
f3ebc0e
Merge pull request #82 from MarketDataApp/dev
MarketDataApp Apr 18, 2025
93957d5
Merge pull request #83 from MarketDataApp/dev
MarketDataApp Apr 21, 2025
97cd5c2
Merge pull request #84 from MarketDataApp/dev
MarketDataApp Apr 30, 2025
f9f9cd9
Merge pull request #85 from MarketDataApp/dev
MarketDataApp May 9, 2025
db599e7
Merge pull request #86 from MarketDataApp/dev
MarketDataApp May 9, 2025
cfde57a
Merge pull request #87 from MarketDataApp/dev
MarketDataApp May 22, 2025
827ec3c
Merge pull request #88 from MarketDataApp/dev
MarketDataApp May 28, 2025
efd20a5
Merge pull request #89 from MarketDataApp/dev
MarketDataApp Jun 7, 2025
5037106
Merge pull request #90 from MarketDataApp/dev
MarketDataApp Jun 7, 2025
c7e7de0
Merge pull request #91 from MarketDataApp/dev
MarketDataApp Jun 8, 2025
076f5e3
Merge pull request #92 from MarketDataApp/dev
MarketDataApp Jun 8, 2025
a203a44
Merge pull request #93 from MarketDataApp/dev
MarketDataApp Jun 8, 2025
af7135c
Merge pull request #94 from MarketDataApp/dev
MarketDataApp Jun 8, 2025
28d26f7
Merge pull request #95 from MarketDataApp/dev
MarketDataApp Dec 15, 2025
36d8d3c
Merge pull request #96 from MarketDataApp/dev
MarketDataApp Dec 16, 2025
45add39
Merge pull request #97 from MarketDataApp/dev
MarketDataApp Dec 19, 2025
1716619
FIX: Resources should show expected output keys
MarketDataDev02 Dec 31, 2025
54c9ea1
Merge branch 'MarketDataApp:main' into SDK_PYTHON_DOCS_IMPROVEMENTS
MarketDataDev02 Dec 31, 2025
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
56 changes: 55 additions & 1 deletion sdk/python/funds/candles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use the `candles()` method on the `funds` resource to fetch fund candles. The me
| Output Format | Return Type | Description |
|---------------|-------------|-------------|
| **DATAFRAME** | `pandas.DataFrame` or `polars.DataFrame` | Returns a DataFrame with candles data (default). |
| **INTERNAL** | `list[FundsCandle]` or `list[FundsCandlesHumanReadable]` | Returns a list of FundsCandle objects or FundsCandlesHumanReadable objects. |
| **INTERNAL** | `list[FundsCandle]` or `list[FundsCandlesHumanReadable]` | Returns a list of FundsCandle objects. When `use_human_readable=True`, returns a list of FundsCandlesHumanReadable objects with capitalized field names. |
| **JSON** | `dict` | Returns the raw JSON response as a dictionary. |
| **CSV** | `str` | Writes CSV data to file and returns the filename string. |

Expand Down Expand Up @@ -234,3 +234,57 @@ for candle in candles:
</TabItem>
</Tabs>

<a name="FundsCandle"></a>
## FundsCandle

```python
@dataclass
class FundsCandle:
t: datetime.datetime
o: float
h: float
l: float
c: float
```

FundsCandle represents a single fund candle (OHLC data), encapsulating price information for a specific time period.

#### Properties

- `t` (datetime.datetime): The timestamp for the candle (automatically converted from Unix timestamp).
- `o` (float): The opening price.
- `h` (float): The highest price.
- `l` (float): The lowest price.
- `c` (float): The closing price.

#### Notes

- The `t` field is automatically converted to a `datetime.datetime` object from a Unix timestamp.

<a name="FundsCandlesHumanReadable"></a>
## FundsCandlesHumanReadable

```python
@dataclass
class FundsCandlesHumanReadable:
Date: datetime.datetime
Open: float
High: float
Low: float
Close: float
```

FundsCandlesHumanReadable represents a fund candle in human-readable format with capitalized field names and formatted values.

#### Properties

- `Date` (datetime.datetime): The timestamp for the candle (automatically converted from Unix timestamp).
- `Open` (float): The opening price.
- `High` (float): The highest price.
- `Low` (float): The lowest price.
- `Close` (float): The closing price.

#### Notes

- The `Date` field is automatically converted to a `datetime.datetime` object from a Unix timestamp.
- Field names use capitalized format (e.g., `Open` instead of `o`, `Date` instead of `t`).
44 changes: 43 additions & 1 deletion sdk/python/markets/status.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use the `status()` method on the `markets` resource to fetch market status infor
| Output Format | Return Type | Description |
|---------------|-------------|-------------|
| **DATAFRAME** | `pandas.DataFrame` or `polars.DataFrame` | Returns a DataFrame with market status data (default). |
| **INTERNAL** | `list[MarketStatus]` or `list[MarketStatusHumanReadable]` | Returns a list of MarketStatus objects or a list of MarketStatusHumanReadable objects. |
| **INTERNAL** | `list[MarketStatus]` or `list[MarketStatusHumanReadable]` | Returns a list of MarketStatus objects. When `use_human_readable=True`, returns a list of MarketStatusHumanReadable objects with capitalized field names. |
| **JSON** | `dict` | Returns the raw JSON response as a dictionary. |
| **CSV** | `str` | Writes CSV data to file and returns the filename string. |

Expand Down Expand Up @@ -216,3 +216,45 @@ for status in status_list:
</TabItem>
</Tabs>

<a name="MarketStatus"></a>
## MarketStatus

```python
@dataclass
class MarketStatus:
date: datetime.date
status: str
```

MarketStatus represents market status information for a specific date, indicating whether the market is open or closed.

#### Properties

- `date` (datetime.date): The date for which the market status applies (automatically converted from timestamp).
- `status` (str): The market status (e.g., "open", "closed").

#### Notes

- The `date` field is automatically converted to a `datetime.date` object from a Unix timestamp.

<a name="MarketStatusHumanReadable"></a>
## MarketStatusHumanReadable

```python
@dataclass
class MarketStatusHumanReadable:
Status: str
Date: datetime.datetime
```

MarketStatusHumanReadable represents market status information in human-readable format with capitalized field names and formatted values.

#### Properties

- `Status` (str): The market status (e.g., "open", "closed").
- `Date` (datetime.datetime): The date for which the market status applies (automatically converted from timestamp).

#### Notes

- The `Date` field is automatically converted to a `datetime.datetime` object from a Unix timestamp.
- Field names use capitalized format (e.g., `Date` instead of `date`, `Status` instead of `status`).
70 changes: 69 additions & 1 deletion sdk/python/options/chain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use the `chain()` method on the `options` resource to fetch options chain data.
| Output Format | Return Type | Description |
|---------------|-------------|-------------|
| **DATAFRAME** | `pandas.DataFrame` or `polars.DataFrame` | Returns a DataFrame with options chain data indexed by optionSymbol (default). |
| **INTERNAL** | `OptionsChain` or `OptionsChainHumanReadable` | Returns an OptionsChain object containing lists of option data. |
| **INTERNAL** | `OptionsChain` or `OptionsChainHumanReadable` | Returns an OptionsChain object containing lists of option data. When `use_human_readable=True`, returns an OptionsChainHumanReadable object with capitalized field names. |
| **JSON** | `dict` | Returns the raw JSON response as a dictionary. |
| **CSV** | `str` | Writes CSV data to file and returns the filename string. |

Expand Down Expand Up @@ -482,3 +482,71 @@ OptionsChain represents the options chain data with lists of equal length for ea
- Timestamp fields (`expiration`, `firstTraded`, `updated`) are automatically converted to `datetime.datetime` objects.
- The `OptionsChainHumanReadable` variant uses capitalized field names with underscores (e.g., `Expiration_Date` instead of `expiration`).

<a name="OptionsChainHumanReadable"></a>
## OptionsChainHumanReadable

```python
@dataclass
class OptionsChainHumanReadable:
Symbol: list[str]
Underlying: list[str]
Expiration_Date: list[datetime.datetime]
Side: list[str]
Strike: list[float]
First_Traded: list[datetime.datetime]
Days_To_Expiration: list[int]
Date: list[datetime.datetime]
Bid: list[float]
Bid_Size: list[int]
Mid: list[float]
Ask: list[float]
Ask_Size: list[int]
Last: list[float]
Open_Interest: list[int]
Volume: list[int]
In_The_Money: list[bool]
Intrinsic_Value: list[float]
Extrinsic_Value: list[float]
Underlying_Price: list[float]
IV: list[float]
Delta: list[float]
Gamma: list[float]
Theta: list[float]
Vega: list[float]
```

OptionsChainHumanReadable represents the options chain data in human-readable format with capitalized field names and formatted values. All lists have the same length, allowing you to access option data by index.

#### Properties

- `Symbol` (list[str]): List of option symbols.
- `Underlying` (list[str]): List of underlying symbols.
- `Expiration_Date` (list[datetime.datetime]): List of expiration dates (automatically converted from timestamps).
- `Option_Side` (list[str]): List of option sides ("call" or "put").
- `Strike` (list[float | int]): List of strike prices.
- `First_Traded` (list[datetime.datetime]): List of first traded dates (automatically converted from timestamps).
- `Days_To_Expiration` (list[int]): List of days to expiration.
- `Date` (list[datetime.datetime]): List of last update timestamps (automatically converted from timestamps).
- `Bid` (list[float]): List of bid prices.
- `Bid_Size` (list[int]): List of bid sizes.
- `Mid` (list[float]): List of mid prices.
- `Ask` (list[float]): List of ask prices.
- `Ask_Size` (list[int]): List of ask sizes.
- `Last` (list[float]): List of last traded prices.
- `Open_Interest` (list[int]): List of open interest values.
- `Volume` (list[int]): List of trading volumes.
- `In_The_Money` (list[bool]): List indicating if options are in the money.
- `Intrinsic_Value` (list[float]): List of intrinsic values.
- `Extrinsic_Value` (list[float]): List of extrinsic values.
- `Underlying_Price` (list[float]): List of underlying prices.
- `IV` (list[float]): List of implied volatilities.
- `Delta` (list[float]): List of Delta values.
- `Gamma` (list[float]): List of Gamma values.
- `Theta` (list[float]): List of Theta values.
- `Vega` (list[float]): List of Vega values.

#### Notes

- All lists have the same length, allowing you to access option data by index (e.g., `chain.Symbol[0]`, `chain.Strike[0]`, etc.).
- Timestamp fields (`Expiration_Date`, `First_Traded`, `Date`) are automatically converted to `datetime.datetime` objects.
- Field names use capitalized format with underscores (e.g., `Expiration_Date` instead of `expiration`, `Option_Side` instead of `side`, `Bid_Size` instead of `bidSize`).
48 changes: 47 additions & 1 deletion sdk/python/options/expirations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use the `expirations()` method on the `options` resource to fetch expiration dat
| Output Format | Return Type | Description |
|---------------|-------------|-------------|
| **DATAFRAME** | `pandas.DataFrame` or `polars.DataFrame` | Returns a DataFrame with expiration dates indexed by expirations (default). |
| **INTERNAL** | `OptionsExpirations` or `OptionsExpirationsHumanReadable` | Returns an OptionsExpirations object. |
| **INTERNAL** | `OptionsExpirations` or `OptionsExpirationsHumanReadable` | Returns an OptionsExpirations object. When `use_human_readable=True`, returns an OptionsExpirationsHumanReadable object with capitalized field names. |
| **JSON** | `dict` | Returns the raw JSON response as a dictionary. |
| **CSV** | `str` | Writes CSV data to file and returns the filename string. |

Expand Down Expand Up @@ -184,3 +184,49 @@ print(f"Date: {expirations.Date}")
</TabItem>
</Tabs>

<a name="OptionsExpirations"></a>
## OptionsExpirations

```python
@dataclass
class OptionsExpirations:
s: str
expirations: list[datetime.datetime]
updated: datetime.datetime
```

OptionsExpirations represents expiration dates for options, encapsulating a list of expiration dates and an update timestamp.

#### Properties

- `s` (str): Status indicator ("ok" for successful responses).
- `expirations` (list[datetime.datetime]): List of expiration dates (automatically converted from timestamps).
- `updated` (datetime.datetime): The time when the data was last updated (automatically converted from timestamp).

#### Notes

- The `expirations` list contains `datetime.datetime` objects automatically converted from Unix timestamps.
- The `updated` field is automatically converted to a `datetime.datetime` object from a Unix timestamp.

<a name="OptionsExpirationsHumanReadable"></a>
## OptionsExpirationsHumanReadable

```python
@dataclass
class OptionsExpirationsHumanReadable:
Expirations: list[datetime.datetime]
Date: datetime.datetime
```

OptionsExpirationsHumanReadable represents expiration dates in human-readable format with capitalized field names and formatted values.

#### Properties

- `Expirations` (list[datetime.datetime]): List of expiration dates (automatically converted from timestamps).
- `Date` (datetime.datetime): The time when the data was last updated (automatically converted from timestamp).

#### Notes

- The `Expirations` list contains `datetime.datetime` objects automatically converted from Unix timestamps.
- The `Date` field is automatically converted to a `datetime.datetime` object from a Unix timestamp.
- Field names use capitalized format (e.g., `Expirations` instead of `expirations`, `Date` instead of `updated`).
37 changes: 36 additions & 1 deletion sdk/python/options/lookup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use the `lookup()` method on the `options` resource to lookup option symbols. Th
| Output Format | Return Type | Description |
|---------------|-------------|-------------|
| **DATAFRAME** | `pandas.DataFrame` or `polars.DataFrame` | Returns a DataFrame with option lookup data indexed by optionSymbol (default). |
| **INTERNAL** | `OptionsLookup` or `OptionsLookupHumanReadable` | Returns an OptionsLookup object. |
| **INTERNAL** | `OptionsLookup` or `OptionsLookupHumanReadable` | Returns an OptionsLookup object. When `use_human_readable=True`, returns an OptionsLookupHumanReadable object with capitalized field names. |
| **JSON** | `dict` | Returns the raw JSON response as a dictionary. |
| **CSV** | `str` | Writes CSV data to file and returns the filename string. |

Expand Down Expand Up @@ -185,3 +185,38 @@ print(f"Symbol: {lookup_result.Symbol}")
</TabItem>
</Tabs>

<a name="OptionsLookup"></a>
## OptionsLookup

```python
@dataclass
class OptionsLookup:
s: str
optionSymbol: str
```

OptionsLookup represents the result of an option symbol lookup, containing the resolved option symbol.

#### Properties

- `s` (str): Status indicator ("ok" for successful responses).
- `optionSymbol` (str): The resolved option symbol.

<a name="OptionsLookupHumanReadable"></a>
## OptionsLookupHumanReadable

```python
@dataclass
class OptionsLookupHumanReadable:
Symbol: str
```

OptionsLookupHumanReadable represents an option symbol lookup result in human-readable format with capitalized field names.

#### Properties

- `Symbol` (str): The resolved option symbol.

#### Notes

- Field names use capitalized format (e.g., `Symbol` instead of `optionSymbol`).
Loading