Skip to content

Added typing for book() and exchangeInfo() HTTP methods #53

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

Merged
merged 2 commits into from
Feb 26, 2018
Merged

Added typing for book() and exchangeInfo() HTTP methods #53

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8b33f1
Added typing for book() and exchangeInfo() HTTP methods
breitsmiley Feb 26, 2018
88fb71a
Update index.d.ts
breitsmiley Feb 26, 2018
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
95 changes: 95 additions & 0 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ declare module 'binance-api-node' {

export interface Binance {
accountInfo(): Promise<Account>;
book(options: { symbol: string, limit?: number }): Promise<OrderBook>;
exchangeInfo(): Promise<ExchangeInfo>;
order(options: NewOrder): Promise<Order>;
prices(): Promise<{ [index: string]: string }>;
time(): Promise<number>;
Expand All @@ -40,6 +42,99 @@ declare module 'binance-api-node' {
user: ( callback: (msg: OutboundAccountInfo|ExecutionReport) => void) => Function;
}

export type RateLimitType =
| 'REQUESTS'
| 'ORDERS';

export type RateLimitInterval =
| 'SECOND'
| 'MINUTE'
| 'DAY';

export interface ExchangeInfoRateLimit {
rateLimitType: RateLimitType;
interval: RateLimitInterval;
limit: number;
}

export type ExchangeFilterType =
| 'EXCHANGE_MAX_NUM_ORDERS'
| 'EXCHANGE_MAX_ALGO_ORDERS';

export interface ExchangeFilter {
filterType: ExchangeFilterType;
limit: number;
}

export type SymbolFilterType =
| 'PRICE_FILTER'
| 'LOT_SIZE'
| 'MIN_NOTIONAL'
| 'MAX_NUM_ORDERS'
| 'MAX_ALGO_ORDERS';

export interface SymbolPriceFilter {
filterType: SymbolFilterType,
minPrice: string;
maxPrice: string;
tickSize: string;
}

export interface SymbolLotSizeFilter {
filterType: SymbolFilterType,
minQty: string;
maxQty: string;
stepSize: string;
}

export interface SymbolMinNotionalFilter {
filterType: SymbolFilterType;
minNotional: string;
}

export interface SymbolMaxNumOrdersFilter {
filterType: SymbolFilterType;
limit: number;
}

export interface SymbolMaxAlgoOrdersFilter {
filterType: SymbolFilterType;
limit: number;
}

export type SymbolFilter =
| SymbolPriceFilter
| SymbolLotSizeFilter
| SymbolMinNotionalFilter
| SymbolMaxNumOrdersFilter
| SymbolMaxAlgoOrdersFilter;

interface Symbol {
symbol: string;
status: string;
baseAsset: string;
baseAssetPrecision: number;
quoteAsset: string;
quotePrecision: number;
orderTypes: OrderType[];
icebergAllowed: boolean;
filters: SymbolFilter[];
}

export interface ExchangeInfo {
timezone: string;
serverTime: number;
rateLimits: ExchangeInfoRateLimit[];
exchangeFilters: ExchangeFilter[];
symbols: Symbol[];
}

export interface OrderBook {
lastUpdateId: number;
asks: Bid[];
bids: Bid[];
}

export interface NewOrder {
icebergQty?: string;
newClientOrderId?: string;
Expand Down