skewtape 0.1.3__py3-none-any.whl

skewtape/__init__.py

@@ -0,0 +1,122 @@
+"""Skewtape: prediction-market data across venues in one schema.
+
+    import skewtape
+
+    sk = skewtape.Skewtape()  # the key from SKEWTAPE_API_KEY, or api_key=...
+    for event in sk.events(min_confidence=0.9, resolution_equal=True):
+        print(event.event_id, event.question_canonical)
+
+sk.kalshi() is the optional live Kalshi client under the user's own Kalshi
+membership (skewtape.kalshi), apart from the API: Skewtape's Kalshi data comes
+from the calls above.
+
+The hand-written facade lives in this package; the client the OpenAPI
+document generates lives in skewtape._generated and is never edited.
+"""
+
+from . import geoblock
+from .backtest import BacktestError, BacktestResult, BacktestWarning, PositionResult, Totals, Trade, TradeResult, run_backtest
+from .client import DEFAULT_BASE_URL, Client, Page, Paginated, Skewtape
+from .download import ChecksumError, download_file, verify_checksums
+from .fees import FeeError, FeeRow, maker_fee_raw, select_fee_row, taker_fee_raw
+from .errors import (
+    AuthenticationError,
+    BlockedError,
+    ConfigurationError,
+    ForbiddenPlanError,
+    InvalidRequestError,
+    NotFoundError,
+    QuotaExceededError,
+    RateLimitError,
+    ServerError,
+    SkewtapeError,
+)
+from .kalshi import (
+    DEFAULT_KALSHI_BASE_URL,
+    Kalshi,
+    KalshiCandlestick,
+    KalshiError,
+    KalshiLevel,
+    KalshiMarket,
+    KalshiOHLC,
+    KalshiOrderbook,
+    KalshiTrade,
+    kalshi_tickers,
+    series_ticker_of,
+)
+from .quote import BookRequest, BookUnavailable, Quote, quote_from_context
+from .quote_math import (
+    InvalidQuoteInputError,
+    QuoteError,
+    QuoteResult,
+    RuleMismatchError,
+    VenueUnreachableError,
+    compute_quote,
+)
+from .route import DFlowOrderRequest, PolymarketOrder, RouteError, route
+from .route_hyperliquid import HyperliquidApproveBuilderFee, HyperliquidOrder, hyperliquid_approve_builder_fee
+from .version import __version__
+
+__all__ = [
+    "DEFAULT_BASE_URL",
+    "DEFAULT_KALSHI_BASE_URL",
+    "AuthenticationError",
+    "BacktestError",
+    "BacktestResult",
+    "BacktestWarning",
+    "BlockedError",
+    "BookRequest",
+    "BookUnavailable",
+    "ChecksumError",
+    "Client",
+    "ConfigurationError",
+    "DFlowOrderRequest",
+    "FeeError",
+    "FeeRow",
+    "ForbiddenPlanError",
+    "HyperliquidApproveBuilderFee",
+    "HyperliquidOrder",
+    "InvalidQuoteInputError",
+    "InvalidRequestError",
+    "Kalshi",
+    "KalshiCandlestick",
+    "KalshiError",
+    "KalshiLevel",
+    "KalshiMarket",
+    "KalshiOHLC",
+    "KalshiOrderbook",
+    "KalshiTrade",
+    "NotFoundError",
+    "Page",
+    "Paginated",
+    "PolymarketOrder",
+    "PositionResult",
+    "QuotaExceededError",
+    "Quote",
+    "QuoteError",
+    "QuoteResult",
+    "RateLimitError",
+    "RouteError",
+    "RuleMismatchError",
+    "ServerError",
+    "Skewtape",
+    "SkewtapeError",
+    "Totals",
+    "Trade",
+    "TradeResult",
+    "VenueUnreachableError",
+    "__version__",
+    "compute_quote",
+    "download_file",
+    "geoblock",
+    "hyperliquid_approve_builder_fee",
+    "kalshi_tickers",
+    "maker_fee_raw",
+    "quote_from_context",
+    "route",
+    "run_backtest",
+    "select_fee_row",
+    "series_ticker_of",
+    "taker_fee_raw",
+    "verify_checksums",
+]

skewtape/_generated/__init__.py

@@ -0,0 +1,9 @@
+# Generated by openapi-python-client 0.29.1 from openapi/skewtape.public.v1.yaml. Do not edit: scripts/sdk-generate.sh rewrites this file.
+"""A client library for accessing Skewtape API"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

skewtape/_generated/api/__init__.py

@@ -0,0 +1,2 @@
+# Generated by openapi-python-client 0.29.1 from openapi/skewtape.public.v1.yaml. Do not edit: scripts/sdk-generate.sh rewrites this file.
+"""Contains methods for accessing the API"""

skewtape/_generated/api/data/__init__.py

@@ -0,0 +1,2 @@
+# Generated by openapi-python-client 0.29.1 from openapi/skewtape.public.v1.yaml. Do not edit: scripts/sdk-generate.sh rewrites this file.
+"""Contains endpoint functions for accessing the API"""

skewtape/_generated/api/data/connect_feed.py

@@ -0,0 +1,491 @@
+# Generated by openapi-python-client 0.29.1 from openapi/skewtape.public.v1.yaml. Do not edit: scripts/sdk-generate.sh rewrites this file.
+from http import HTTPStatus
+from typing import Any, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.error_envelope import ErrorEnvelope
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    x_api_key: str | Unset = UNSET,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+    if not isinstance(x_api_key, Unset):
+        headers["X-API-Key"] = x_api_key
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/feed",
+    }
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Any | ErrorEnvelope | None:
+    if response.status_code == 101:
+        response_101 = cast(Any, None)
+        return response_101
+
+    if response.status_code == 401:
+        response_401 = ErrorEnvelope.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 503:
+        response_503 = ErrorEnvelope.from_dict(response.json())
+
+        return response_503
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[Any | ErrorEnvelope]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    x_api_key: str | Unset = UNSET,
+) -> Response[Any | ErrorEnvelope]:
+    """Live feed (WebSocket)
+
+     The live feed, over a WebSocket. Builder and Pro plans: Builder holds
+    up to 3 open connections and Pro up to 10, counted across all of an
+    account's keys. The live feed guide, https://docs.skewtape.com/feed,
+    has the whole protocol with examples; this is its summary.
+
+    Authentication: the X-API-Key header on the upgrade request, or the
+    first message {"op":"auth","key":"st_live_..."} within 10 seconds.
+
+    Topics: markets, resolutions, trades and matched_events on Builder
+    and Pro; event_spread on Pro only. A subscribe that names a topic
+    outside the plan is refused with error topic_not_in_plan and an
+    upgrade_url, and nothing of that subscribe applies: the previous
+    subscription stays, and on a first subscribe there is none. Send it
+    again without the topic. A topic the feed does not have is refused
+    with error invalid_subscription. A plan that loses a topic during a
+    connection is told the same way and keeps its other topics.
+
+    From the client:
+    {"op":"subscribe","topics":["markets","trades","event_spread"],
+    "venues":["kalshi"],"markets":[{"venue":"polymarket","market_id":"0x..."}],
+    "events":["st_evt_00412"],"resume_from":123} replaces the
+    subscription. topics is required; venues, markets and events are
+    optional filters, ORed. events, matched event ids, narrows
+    event_spread and matched_events, whose events belong to a matched
+    event rather than a venue, so the venue and market filters do not
+    narrow them; it needs one of those two topics, and leaves the other
+    topics to the venue and market filters, whole when there are none.
+    A market filter cuts a trades_batch down to its markets' fills.
+    {"op":"ping"} is answered {"op":"pong"} at once, even during a
+    replay.
+
+    matched_events carries the changes to what /v1/matched_events
+    returns, within five minutes: an event published (kind
+    matched_event_published), changed (matched_event_changed: any field
+    but updated_at, reviewer_notes included, so a Builder key can get a
+    change it cannot see) or retired (matched_event_retired: no longer
+    returned, whatever the reason; its payload is the event_id and the
+    status alone). A published or changed event's payload is the event as
+    /v1/matched_events returns it. The topic has no snapshot: read
+    /v1/matched_events once for the current set, then follow the changes.
+
+    From the server, each message with an op: hello (connection id, plan,
+    current seq, replay window and reconnect schedule), subscribed (what
+    was accepted, replay_to and masked_venues), snapshot (the latest
+    spread of each matched event the subscription names, sent right
+    after subscribed; it has no seq), event (seq, topic, kind, venue,
+    market_id, at, payload), resync (resume_from is older than the replay
+    window: read the REST API for what you missed), reconnect (at 55
+    minutes, with resume_from; the connection closes at 59) and error
+    (code, message, and upgrade_url on a plan refusal).
+
+    Trades: one event per fill, up to 400 a second per venue, the rest of
+    that second in one trades_batch. A fill can arrive twice: dedupe by
+    (venue, tx_hash, log_index). A trade_withdrawn names a streamed trade
+    (limitless, myriad, predictfun) whose block a chain reorganisation
+    replaced without it: drop the trade with that identity. If its transaction is mined again, it
+    arrives as a new trade under its new identity. event_spread: a matched event's
+    fee-adjusted spread, at most one event per matched event every five
+    seconds.
+
+    Resume: keep the last seq you saw and send it as resume_from. The feed
+    replays the stored events after it that match the subscription, then
+    goes on live with no gap and no duplicate. A gap notice (topic feed,
+    kind gap) means a venue stream reconnected: read the REST API for that
+    window.
+
+    Data policy: a subscription naming a venue or a market of a venue the
+    policy blocks for live data is refused (error venue_blocked). A masked
+    venue's events arrive with the withheld fields null and blocked true.
+    A matched event the feed serves arrives whole: a member of a blocked venue keeps its
+    ids, its side labels are null, its outcome_map is empty and blocked
+    is true.
+
+    Close codes: 4000 reconnect (connect again with resume_from), 4001
+    unauthorized (also when the key is revoked: keys are checked again
+    every few minutes), 4003 plan (no feed, or a plan change left no
+    topic of the subscription), 4008 connection limit, 4009 slow consumer (resume from the
+    seq in the close reason), 4029 too many failed key lookups, 4400 bad
+    message, 1001 server restarting, 1011 server error (connect again
+    with resume_from).
+
+    Args:
+        x_api_key (str | Unset):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any | ErrorEnvelope]
+    """
+
+    kwargs = _get_kwargs(
+        x_api_key=x_api_key,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    x_api_key: str | Unset = UNSET,
+) -> Any | ErrorEnvelope | None:
+    """Live feed (WebSocket)
+
+     The live feed, over a WebSocket. Builder and Pro plans: Builder holds
+    up to 3 open connections and Pro up to 10, counted across all of an
+    account's keys. The live feed guide, https://docs.skewtape.com/feed,
+    has the whole protocol with examples; this is its summary.
+
+    Authentication: the X-API-Key header on the upgrade request, or the
+    first message {"op":"auth","key":"st_live_..."} within 10 seconds.
+
+    Topics: markets, resolutions, trades and matched_events on Builder
+    and Pro; event_spread on Pro only. A subscribe that names a topic
+    outside the plan is refused with error topic_not_in_plan and an
+    upgrade_url, and nothing of that subscribe applies: the previous
+    subscription stays, and on a first subscribe there is none. Send it
+    again without the topic. A topic the feed does not have is refused
+    with error invalid_subscription. A plan that loses a topic during a
+    connection is told the same way and keeps its other topics.
+
+    From the client:
+    {"op":"subscribe","topics":["markets","trades","event_spread"],
+    "venues":["kalshi"],"markets":[{"venue":"polymarket","market_id":"0x..."}],
+    "events":["st_evt_00412"],"resume_from":123} replaces the
+    subscription. topics is required; venues, markets and events are
+    optional filters, ORed. events, matched event ids, narrows
+    event_spread and matched_events, whose events belong to a matched
+    event rather than a venue, so the venue and market filters do not
+    narrow them; it needs one of those two topics, and leaves the other
+    topics to the venue and market filters, whole when there are none.
+    A market filter cuts a trades_batch down to its markets' fills.
+    {"op":"ping"} is answered {"op":"pong"} at once, even during a
+    replay.
+
+    matched_events carries the changes to what /v1/matched_events
+    returns, within five minutes: an event published (kind
+    matched_event_published), changed (matched_event_changed: any field
+    but updated_at, reviewer_notes included, so a Builder key can get a
+    change it cannot see) or retired (matched_event_retired: no longer
+    returned, whatever the reason; its payload is the event_id and the
+    status alone). A published or changed event's payload is the event as
+    /v1/matched_events returns it. The topic has no snapshot: read
+    /v1/matched_events once for the current set, then follow the changes.
+
+    From the server, each message with an op: hello (connection id, plan,
+    current seq, replay window and reconnect schedule), subscribed (what
+    was accepted, replay_to and masked_venues), snapshot (the latest
+    spread of each matched event the subscription names, sent right
+    after subscribed; it has no seq), event (seq, topic, kind, venue,
+    market_id, at, payload), resync (resume_from is older than the replay
+    window: read the REST API for what you missed), reconnect (at 55
+    minutes, with resume_from; the connection closes at 59) and error
+    (code, message, and upgrade_url on a plan refusal).
+
+    Trades: one event per fill, up to 400 a second per venue, the rest of
+    that second in one trades_batch. A fill can arrive twice: dedupe by
+    (venue, tx_hash, log_index). A trade_withdrawn names a streamed trade
+    (limitless, myriad, predictfun) whose block a chain reorganisation
+    replaced without it: drop the trade with that identity. If its transaction is mined again, it
+    arrives as a new trade under its new identity. event_spread: a matched event's
+    fee-adjusted spread, at most one event per matched event every five
+    seconds.
+
+    Resume: keep the last seq you saw and send it as resume_from. The feed
+    replays the stored events after it that match the subscription, then
+    goes on live with no gap and no duplicate. A gap notice (topic feed,
+    kind gap) means a venue stream reconnected: read the REST API for that
+    window.
+
+    Data policy: a subscription naming a venue or a market of a venue the
+    policy blocks for live data is refused (error venue_blocked). A masked
+    venue's events arrive with the withheld fields null and blocked true.
+    A matched event the feed serves arrives whole: a member of a blocked venue keeps its
+    ids, its side labels are null, its outcome_map is empty and blocked
+    is true.
+
+    Close codes: 4000 reconnect (connect again with resume_from), 4001
+    unauthorized (also when the key is revoked: keys are checked again
+    every few minutes), 4003 plan (no feed, or a plan change left no
+    topic of the subscription), 4008 connection limit, 4009 slow consumer (resume from the
+    seq in the close reason), 4029 too many failed key lookups, 4400 bad
+    message, 1001 server restarting, 1011 server error (connect again
+    with resume_from).
+
+    Args:
+        x_api_key (str | Unset):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Any | ErrorEnvelope
+    """
+
+    return sync_detailed(
+        client=client,
+        x_api_key=x_api_key,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    x_api_key: str | Unset = UNSET,
+) -> Response[Any | ErrorEnvelope]:
+    """Live feed (WebSocket)
+
+     The live feed, over a WebSocket. Builder and Pro plans: Builder holds
+    up to 3 open connections and Pro up to 10, counted across all of an
+    account's keys. The live feed guide, https://docs.skewtape.com/feed,
+    has the whole protocol with examples; this is its summary.
+
+    Authentication: the X-API-Key header on the upgrade request, or the
+    first message {"op":"auth","key":"st_live_..."} within 10 seconds.
+
+    Topics: markets, resolutions, trades and matched_events on Builder
+    and Pro; event_spread on Pro only. A subscribe that names a topic
+    outside the plan is refused with error topic_not_in_plan and an
+    upgrade_url, and nothing of that subscribe applies: the previous
+    subscription stays, and on a first subscribe there is none. Send it
+    again without the topic. A topic the feed does not have is refused
+    with error invalid_subscription. A plan that loses a topic during a
+    connection is told the same way and keeps its other topics.
+
+    From the client:
+    {"op":"subscribe","topics":["markets","trades","event_spread"],
+    "venues":["kalshi"],"markets":[{"venue":"polymarket","market_id":"0x..."}],
+    "events":["st_evt_00412"],"resume_from":123} replaces the
+    subscription. topics is required; venues, markets and events are
+    optional filters, ORed. events, matched event ids, narrows
+    event_spread and matched_events, whose events belong to a matched
+    event rather than a venue, so the venue and market filters do not
+    narrow them; it needs one of those two topics, and leaves the other
+    topics to the venue and market filters, whole when there are none.
+    A market filter cuts a trades_batch down to its markets' fills.
+    {"op":"ping"} is answered {"op":"pong"} at once, even during a
+    replay.
+
+    matched_events carries the changes to what /v1/matched_events
+    returns, within five minutes: an event published (kind
+    matched_event_published), changed (matched_event_changed: any field
+    but updated_at, reviewer_notes included, so a Builder key can get a
+    change it cannot see) or retired (matched_event_retired: no longer
+    returned, whatever the reason; its payload is the event_id and the
+    status alone). A published or changed event's payload is the event as
+    /v1/matched_events returns it. The topic has no snapshot: read
+    /v1/matched_events once for the current set, then follow the changes.
+
+    From the server, each message with an op: hello (connection id, plan,
+    current seq, replay window and reconnect schedule), subscribed (what
+    was accepted, replay_to and masked_venues), snapshot (the latest
+    spread of each matched event the subscription names, sent right
+    after subscribed; it has no seq), event (seq, topic, kind, venue,
+    market_id, at, payload), resync (resume_from is older than the replay
+    window: read the REST API for what you missed), reconnect (at 55
+    minutes, with resume_from; the connection closes at 59) and error
+    (code, message, and upgrade_url on a plan refusal).
+
+    Trades: one event per fill, up to 400 a second per venue, the rest of
+    that second in one trades_batch. A fill can arrive twice: dedupe by
+    (venue, tx_hash, log_index). A trade_withdrawn names a streamed trade
+    (limitless, myriad, predictfun) whose block a chain reorganisation
+    replaced without it: drop the trade with that identity. If its transaction is mined again, it
+    arrives as a new trade under its new identity. event_spread: a matched event's
+    fee-adjusted spread, at most one event per matched event every five
+    seconds.
+
+    Resume: keep the last seq you saw and send it as resume_from. The feed
+    replays the stored events after it that match the subscription, then
+    goes on live with no gap and no duplicate. A gap notice (topic feed,
+    kind gap) means a venue stream reconnected: read the REST API for that
+    window.
+
+    Data policy: a subscription naming a venue or a market of a venue the
+    policy blocks for live data is refused (error venue_blocked). A masked
+    venue's events arrive with the withheld fields null and blocked true.
+    A matched event the feed serves arrives whole: a member of a blocked venue keeps its
+    ids, its side labels are null, its outcome_map is empty and blocked
+    is true.
+
+    Close codes: 4000 reconnect (connect again with resume_from), 4001
+    unauthorized (also when the key is revoked: keys are checked again
+    every few minutes), 4003 plan (no feed, or a plan change left no
+    topic of the subscription), 4008 connection limit, 4009 slow consumer (resume from the
+    seq in the close reason), 4029 too many failed key lookups, 4400 bad
+    message, 1001 server restarting, 1011 server error (connect again
+    with resume_from).
+
+    Args:
+        x_api_key (str | Unset):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any | ErrorEnvelope]
+    """
+
+    kwargs = _get_kwargs(
+        x_api_key=x_api_key,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    x_api_key: str | Unset = UNSET,
+) -> Any | ErrorEnvelope | None:
+    """Live feed (WebSocket)
+
+     The live feed, over a WebSocket. Builder and Pro plans: Builder holds
+    up to 3 open connections and Pro up to 10, counted across all of an
+    account's keys. The live feed guide, https://docs.skewtape.com/feed,
+    has the whole protocol with examples; this is its summary.
+
+    Authentication: the X-API-Key header on the upgrade request, or the
+    first message {"op":"auth","key":"st_live_..."} within 10 seconds.
+
+    Topics: markets, resolutions, trades and matched_events on Builder
+    and Pro; event_spread on Pro only. A subscribe that names a topic
+    outside the plan is refused with error topic_not_in_plan and an
+    upgrade_url, and nothing of that subscribe applies: the previous
+    subscription stays, and on a first subscribe there is none. Send it
+    again without the topic. A topic the feed does not have is refused
+    with error invalid_subscription. A plan that loses a topic during a
+    connection is told the same way and keeps its other topics.
+
+    From the client:
+    {"op":"subscribe","topics":["markets","trades","event_spread"],
+    "venues":["kalshi"],"markets":[{"venue":"polymarket","market_id":"0x..."}],
+    "events":["st_evt_00412"],"resume_from":123} replaces the
+    subscription. topics is required; venues, markets and events are
+    optional filters, ORed. events, matched event ids, narrows
+    event_spread and matched_events, whose events belong to a matched
+    event rather than a venue, so the venue and market filters do not
+    narrow them; it needs one of those two topics, and leaves the other
+    topics to the venue and market filters, whole when there are none.
+    A market filter cuts a trades_batch down to its markets' fills.
+    {"op":"ping"} is answered {"op":"pong"} at once, even during a
+    replay.
+
+    matched_events carries the changes to what /v1/matched_events
+    returns, within five minutes: an event published (kind
+    matched_event_published), changed (matched_event_changed: any field
+    but updated_at, reviewer_notes included, so a Builder key can get a
+    change it cannot see) or retired (matched_event_retired: no longer
+    returned, whatever the reason; its payload is the event_id and the
+    status alone). A published or changed event's payload is the event as
+    /v1/matched_events returns it. The topic has no snapshot: read
+    /v1/matched_events once for the current set, then follow the changes.
+
+    From the server, each message with an op: hello (connection id, plan,
+    current seq, replay window and reconnect schedule), subscribed (what
+    was accepted, replay_to and masked_venues), snapshot (the latest
+    spread of each matched event the subscription names, sent right
+    after subscribed; it has no seq), event (seq, topic, kind, venue,
+    market_id, at, payload), resync (resume_from is older than the replay
+    window: read the REST API for what you missed), reconnect (at 55
+    minutes, with resume_from; the connection closes at 59) and error
+    (code, message, and upgrade_url on a plan refusal).
+
+    Trades: one event per fill, up to 400 a second per venue, the rest of
+    that second in one trades_batch. A fill can arrive twice: dedupe by
+    (venue, tx_hash, log_index). A trade_withdrawn names a streamed trade
+    (limitless, myriad, predictfun) whose block a chain reorganisation
+    replaced without it: drop the trade with that identity. If its transaction is mined again, it
+    arrives as a new trade under its new identity. event_spread: a matched event's
+    fee-adjusted spread, at most one event per matched event every five
+    seconds.
+
+    Resume: keep the last seq you saw and send it as resume_from. The feed
+    replays the stored events after it that match the subscription, then
+    goes on live with no gap and no duplicate. A gap notice (topic feed,
+    kind gap) means a venue stream reconnected: read the REST API for that
+    window.
+
+    Data policy: a subscription naming a venue or a market of a venue the
+    policy blocks for live data is refused (error venue_blocked). A masked
+    venue's events arrive with the withheld fields null and blocked true.
+    A matched event the feed serves arrives whole: a member of a blocked venue keeps its
+    ids, its side labels are null, its outcome_map is empty and blocked
+    is true.
+
+    Close codes: 4000 reconnect (connect again with resume_from), 4001
+    unauthorized (also when the key is revoked: keys are checked again
+    every few minutes), 4003 plan (no feed, or a plan change left no
+    topic of the subscription), 4008 connection limit, 4009 slow consumer (resume from the
+    seq in the close reason), 4029 too many failed key lookups, 4400 bad
+    message, 1001 server restarting, 1011 server error (connect again
+    with resume_from).
+
+    Args:
+        x_api_key (str | Unset):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Any | ErrorEnvelope
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            x_api_key=x_api_key,
+        )
+    ).parsed