orderbook

Classes

SharedOrderbookClient

Constructors

Constructor


new SharedOrderbookClient(baseUrl, opts?): SharedOrderbookClient;

Parameters

Parameter	Type
`baseUrl`	`string`
`opts`	`ClientOpts`

Returns

SharedOrderbookClient

Methods

isOnline()


isOnline(): Promise<boolean>;

Returns

Promise<boolean>

getStats()


getStats(): Promise<SharedOrderbookStats | null>;

Returns

Promise<SharedOrderbookStats | null>

getRelayers()


getRelayers(): Promise<SharedRelayer[]>;

Returns

Promise<SharedRelayer[]>

getOrders()


getOrders(limit?, status?): Promise<SharedOrder[]>;

Parameters

Parameter	Type	Default value
`limit`	`number`	`500`
`status?`	`SharedOrderStatus` \| `"all"`	`undefined`

Returns

Promise<SharedOrder[]>

getOrdersWithCounts()


getOrdersWithCounts(limit?, status?): Promise<{
  orders: SharedOrder[];
  counts: Partial<Record<SharedOrderStatus, number>>;
}>;

Variant that returns the full payload including the per-status counts the bucket-tab UI needs. Kept as a separate method so the common getOrders() call site doesn’t have to destructure a wrapper every time.

Parameters

Parameter	Type	Default value
`limit`	`number`	`500`
`status?`	`SharedOrderStatus` \| `"all"`	`undefined`

Returns

Promise<{ orders: SharedOrder[]; counts: Partial<Record<SharedOrderStatus, number>>; }>

getOrdersByPair()


getOrdersByPair(pair): Promise<SharedOrder[]>;

Parameters

Parameter	Type
`pair`	`string`

Returns

Promise<SharedOrder[]>

Interfaces

SharedOrderbookStats

Properties

Property	Type
`totalOrders`	`number`
`pairs`	`number`
`relayers`	`number`

SharedRelayer

Properties

Property	Type
`address`	`string`
`url`	`string`
`name?`	`string`
`orderCount`	`number`
`lastHeartbeat`	`number`

SharedOrder

Properties

Property	Type	Description
`id`	`string`	-
`relayer`	`string`	-
`relayerUrl`	`string`	-
`nonce`	`string`	-
`pubKeyAx`	`string`	-
`sellToken`	`string`	-
`buyToken`	`string`	-
`sellAmount`	`string`	-
`buyAmount`	`string`	-
`minFillAmount`	`string`	-
`maxFee`	`number`	-
`expiry`	`number`	-
`createdAt`	`number`	-
`chainId?`	`number`	EVM network this order lives on. Present on every row the multi-network backend returns; undefined from a legacy backend.
`status?`	`SharedOrderStatus`	Present when the API was queried with `status=<bucket>` or `status=all`. Undefined for legacy callers reading the default “open”-only view — those rows are always open by definition.

Type Aliases

SharedOrderStatus


type SharedOrderStatus = "open" | "matched" | "cancelled" | "expired";

Lifecycle status the shared orderbook tracks server-side. Mirrors @scatter-dex/types’ OrderStatus union — duplicated here so the SDK consumer doesn’t have to pull the types-only package.