Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
34 changes: 17 additions & 17 deletions massive/rest/futures.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
class FuturesClient(BaseClient):
"""
Client for the Futures REST Endpoints
(aligned with the paths from /futures/vX/...)
(aligned with the paths from /futures/v1/...)
"""

def list_futures_aggregates(
Expand All @@ -40,15 +40,15 @@ def list_futures_aggregates(
options: Optional[RequestOptionBuilder] = None,
) -> Union[Iterator[FuturesAgg], HTTPResponse]:
"""
Endpoint: GET /futures/vX/aggs/{ticker}
Endpoint: GET /futures/v1/aggs/{ticker}

Get aggregates for a futures contract in a given time range.
This endpoint returns data that includes:
- open, close, high, low
- volume, dollar_volume, etc.
If `next_url` is present, it will be paginated.
"""
url = f"/futures/vX/aggs/{ticker}"
url = f"/futures/v1/aggs/{ticker}"
return self._paginate(
path=url,
params=self._get_params(self.list_futures_aggregates, locals()),
Expand Down Expand Up @@ -96,11 +96,11 @@ def list_futures_contracts(
options: Optional[RequestOptionBuilder] = None,
) -> Union[Iterator[FuturesContract], HTTPResponse]:
"""
Endpoint: GET /futures/vX/contracts
Endpoint: GET /futures/v1/contracts

The Contracts endpoint returns a paginated list of futures contracts.
"""
url = "/futures/vX/contracts"
url = "/futures/v1/contracts"
return self._paginate(
path=url,
params=self._get_params(self.list_futures_contracts, locals()),
Expand Down Expand Up @@ -151,11 +151,11 @@ def list_futures_products(
options: Optional[RequestOptionBuilder] = None,
) -> Union[Iterator[FuturesProduct], HTTPResponse]:
"""
Endpoint: GET /futures/vX/products
Endpoint: GET /futures/v1/products

Returns a list of futures products (including combos).
"""
url = "/futures/vX/products"
url = "/futures/v1/products"
return self._paginate(
path=url,
params=self._get_params(self.list_futures_products, locals()),
Expand Down Expand Up @@ -184,11 +184,11 @@ def list_futures_quotes(
options: Optional[RequestOptionBuilder] = None,
) -> Union[Iterator[FuturesQuote], HTTPResponse]:
"""
Endpoint: GET /futures/vX/quotes/{ticker}
Endpoint: GET /futures/v1/quotes/{ticker}

Get quotes for a contract in a given time range (paginated).
"""
url = f"/futures/vX/quotes/{ticker}"
url = f"/futures/v1/quotes/{ticker}"
return self._paginate(
path=url,
params=self._get_params(self.list_futures_quotes, locals()),
Expand Down Expand Up @@ -217,11 +217,11 @@ def list_futures_trades(
options: Optional[RequestOptionBuilder] = None,
) -> Union[Iterator[FuturesTrade], HTTPResponse]:
"""
Endpoint: GET /futures/vX/trades/{ticker}
Endpoint: GET /futures/v1/trades/{ticker}

Get trades for a contract in a given time range (paginated).
"""
url = f"/futures/vX/trades/{ticker}"
url = f"/futures/v1/trades/{ticker}"
return self._paginate(
path=url,
params=self._get_params(self.list_futures_trades, locals()),
Expand Down Expand Up @@ -257,12 +257,12 @@ def list_futures_schedules(
options: Optional[RequestOptionBuilder] = None,
) -> Union[Iterator[FuturesSchedule], HTTPResponse]:
"""
Endpoint: GET /futures/vX/schedules
Endpoint: GET /futures/v1/schedules

Returns a list of trading schedules for multiple futures products on a specific date.
If `next_url` is present, this is paginated.
"""
url = "/futures/vX/schedules"
url = "/futures/v1/schedules"
return self._paginate(
path=url,
params=self._get_params(self.list_futures_schedules, locals()),
Expand All @@ -284,7 +284,7 @@ def list_futures_market_statuses(
raw: bool = False,
options: Optional[RequestOptionBuilder] = None,
) -> Union[Iterator[FuturesMarketStatus], HTTPResponse]:
url = "/futures/vX/market-status"
url = "/futures/v1/market-status"
return self._paginate(
path=url,
params=self._get_params(self.list_futures_market_statuses, locals()),
Expand Down Expand Up @@ -313,7 +313,7 @@ def get_futures_snapshot(
raw: bool = False,
options: Optional[RequestOptionBuilder] = None,
) -> Union[Iterator[FuturesSnapshot], HTTPResponse]:
url = "/futures/vX/snapshot"
url = "/futures/v1/snapshot"
return self._paginate(
path=url,
params=self._get_params(self.get_futures_snapshot, locals()),
Expand All @@ -330,11 +330,11 @@ def list_futures_exchanges(
options: Optional[RequestOptionBuilder] = None,
) -> Union[Iterator[FuturesExchange], HTTPResponse]:
"""
Endpoint: GET /futures/vX/exchanges
Endpoint: GET /futures/v1/exchanges

US futures exchanges and trading venues including major derivatives exchanges (CME, CBOT, NYMEX, COMEX) and other futures market infrastructure for commodity, financial, and other derivative contract trading.
"""
url = "/futures/vX/exchanges"
url = "/futures/v1/exchanges"
return self._paginate(
path=url,
params=self._get_params(self.list_futures_exchanges, locals()),
Expand Down
14 changes: 7 additions & 7 deletions massive/rest/models/futures.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
class FuturesAgg:
"""
A single aggregate bar for a futures contract in a given time window.
Corresponds to /futures/vX/aggs/{ticker}.
Corresponds to /futures/v1/aggs/{ticker}.
"""

ticker: Optional[str] = None
Expand Down Expand Up @@ -42,7 +42,7 @@ def from_dict(d):
class FuturesContract:
"""
Represents a single futures contract (or a 'combo' contract).
Corresponds to /futures/vX/contracts endpoints.
Corresponds to /futures/v1/contracts endpoints.
"""

ticker: Optional[str] = None
Expand Down Expand Up @@ -90,7 +90,7 @@ def from_dict(d):
class FuturesProduct:
"""
Represents a single futures product (or product 'combo').
Corresponds to /futures/vX/products endpoints.
Corresponds to /futures/v1/products endpoints.
"""

product_code: Optional[str] = None
Expand Down Expand Up @@ -138,7 +138,7 @@ def from_dict(d):
class FuturesQuote:
"""
Represents a futures NBBO quote within a given time range.
Corresponds to /futures/vX/quotes/{ticker}
Corresponds to /futures/v1/quotes/{ticker}
"""

ticker: Optional[str] = None
Expand Down Expand Up @@ -174,7 +174,7 @@ def from_dict(d):
class FuturesTrade:
"""
Represents a futures trade within a given time range.
Corresponds to /futures/vX/trades/{ticker}
Corresponds to /futures/v1/trades/{ticker}
"""

ticker: Optional[str] = None
Expand Down Expand Up @@ -202,7 +202,7 @@ def from_dict(d):
class FuturesSchedule:
"""
Represents a single schedule event for a given session_end_date and product.
Corresponds to /futures/vX/schedules
Corresponds to /futures/v1/schedules
"""

event: Optional[str] = None
Expand Down Expand Up @@ -397,7 +397,7 @@ def from_dict(d):
class FuturesExchange:
"""
Represents a futures exchange or trading venue.
Corresponds to /futures/vX/exchanges endpoint.
Corresponds to /futures/v1/exchanges endpoint.
"""

acronym: Optional[str] = None
Expand Down
Loading