Skip to content

docs: fix Python signatures for indexer websocket orders/trades #447

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

Open
alexey-kichin wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix Python signatures for indexer websocket orders/trades #447

Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions docs/pages/indexer-client/websockets/orders.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Data feed of the orders of a market. Data contains lists of the bids and asks of

```python [Python]
# class `OrderBook`
def subscribe(self, market: str, batched: bool = True) -> Self
def unsubscribe(self, market: str)
def subscribe(self, id: str, batched: bool = True) -> Self
def unsubscribe(self, id: str)
```

```typescript [TypeScript]
Expand Down
6 changes: 3 additions & 3 deletions docs/pages/indexer-client/websockets/trades.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Data feed of the trades on a market. Data contains order fills updates, such as

```python [Python]
# class `Trades`
def subscribe(self, market: str, batched: bool = True) -> Self
def unsubscribe(self, market: str)
def subscribe(self, id: str, batched: bool = True) -> Self
def unsubscribe(self, id: str)
```

```typescript [TypeScript]
Expand All @@ -31,7 +31,7 @@ pub async fn trades(
```

```url [Channel]
v4_orderbook
v4_trades
```

:::
Expand Down
Loading