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
9,880 changes: 4,963 additions & 4,917 deletions llms.txt

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "binance",
"version": "3.6.2",
"version": "3.6.3",
"description": "Professional Node.js & JavaScript SDK for Binance REST APIs & WebSockets, with TypeScript & end-to-end tests.",
"main": "lib/index.js",
"types": "lib/index.d.ts",
Expand Down
1 change: 1 addition & 0 deletions src/types/futures.ts
Original file line number Diff line number Diff line change
Expand Up @@ -447,6 +447,7 @@ export interface NewOrderResult {
priceProtect: boolean;
selfTradePreventionMode: SelfTradePreventionMode;
priceMatch: PriceMatchMode;
goodTillDate?: number;
}

export interface NewOrderError {
Expand Down
11 changes: 8 additions & 3 deletions src/types/shared.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ export type OrderTimeInForce =
| 'FOK'
| 'GTX'
| 'GTE_GTC'
| 'GTD';
| 'GTD'
| 'RPI';

export type StringBoolean = 'TRUE' | 'FALSE';

Expand Down Expand Up @@ -67,12 +68,14 @@ export type OrderSide = 'BUY' | 'SELL';

export type OrderStatus =
| 'NEW'
| 'PENDING_NEW'
| 'PARTIALLY_FILLED'
| 'FILLED'
| 'CANCELED'
| 'PENDING_CANCEL'
| 'REJECTED'
| 'EXPIRED';
| 'EXPIRED'
| 'EXPIRED_IN_MATCH';

export type OrderExecutionType =
| 'NEW'
Expand Down Expand Up @@ -107,7 +110,9 @@ export type SelfTradePreventionMode =
| 'EXPIRE_TAKER'
| 'EXPIRE_MAKER'
| 'EXPIRE_BOTH'
| 'NONE';
| 'NONE'
| 'DECREMENT'
| 'TRANSFER';

export interface BasicAssetParam {
asset: string;
Expand Down
30 changes: 28 additions & 2 deletions src/types/spot.ts
Original file line number Diff line number Diff line change
Expand Up @@ -464,6 +464,9 @@ export interface ExchangeInfoParams {
symbolStatus?: string;
}

type SpotPegPriceType = 'PRIMARY_PEG' | 'MARKET_PEG';
type SpotPegOffsetType = 'PRICE_LEVEL';

export interface NewSpotOrderParams<
T extends OrderType = OrderType,
RT extends OrderResponseType | undefined = OrderResponseType,
Expand All @@ -482,6 +485,10 @@ export interface NewSpotOrderParams<
trailingDelta?: number;
icebergQty?: number;
newOrderRespType?: RT;
selfTradePreventionMode?: SelfTradePreventionMode;
pegPriceType?: SpotPegPriceType;
pegOffsetValue?: number;
pegOffsetType?: SpotPegOffsetType;
isIsolated?: StringBoolean;
sideEffectType?: SideEffects;
autoRepayAtCancel?: StringBoolean;
Expand Down Expand Up @@ -771,7 +778,23 @@ export interface OrderResponseACK {
transactTime: number;
}

export interface OrderResponseResult {
/** Conditional fields on POST /api/v3/order RESULT/FULL. Only present when the matching condition is met. */
export interface SpotNewOrderConditionalFields {
icebergQty?: numberInString;
preventedMatchId?: number;
preventedQuantity?: numberInString;
stopPrice?: numberInString;
strategyId?: number;
strategyType?: number;
trailingDelta?: number;
trailingTime?: number;
pegPriceType?: SpotPegPriceType;
pegOffsetType?: SpotPegOffsetType;
pegOffsetValue?: number;
peggedPrice?: numberInString;
}

export interface OrderResponseResult extends SpotNewOrderConditionalFields {
symbol: string;
orderId: number;
orderListId: number;
Expand All @@ -780,6 +803,7 @@ export interface OrderResponseResult {
price: numberInString;
origQty: numberInString;
executedQty: numberInString;
origQuoteOrderQty: numberInString;
cummulativeQuoteQty: numberInString;
status: OrderStatus;
timeInForce: OrderTimeInForce;
Expand All @@ -796,9 +820,10 @@ export interface OrderFill {
qty: numberInString;
commission: numberInString;
commissionAsset: string;
tradeId: number;
}

export interface OrderResponseFull {
export interface OrderResponseFull extends SpotNewOrderConditionalFields {
symbol: string;
orderId: number;
orderListId?: number;
Expand All @@ -807,6 +832,7 @@ export interface OrderResponseFull {
price: numberInString;
origQty: numberInString;
executedQty: numberInString;
origQuoteOrderQty: numberInString;
cummulativeQuoteQty: numberInString;
status: OrderStatus;
timeInForce: OrderTimeInForce;
Expand Down
17 changes: 14 additions & 3 deletions src/types/websockets/ws-api-requests.ts
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,8 @@ export interface WSAPIMyAllocationsRequest {
/**
* Trading request types
*/
type SpotPegPriceType = 'PRIMARY_PEG' | 'MARKET_PEG';
type SpotPegOffsetType = 'PRICE_LEVEL';

export interface WSAPINewSpotOrderRequest {
symbol: string;
Expand All @@ -231,7 +233,10 @@ export interface WSAPINewSpotOrderRequest {
icebergQty?: numberInString;
strategyId?: number;
strategyType?: number;
selfTradePreventionMode?: string;
selfTradePreventionMode?: SelfTradePreventionMode;
pegPriceType?: SpotPegPriceType;
pegOffsetValue?: number;
pegOffsetType?: SpotPegOffsetType;
}

export interface WSAPIOrderTestRequest {
Expand All @@ -248,7 +253,10 @@ export interface WSAPIOrderTestRequest {
icebergQty?: numberInString;
strategyId?: number;
strategyType?: number;
selfTradePreventionMode?: string;
selfTradePreventionMode?: SelfTradePreventionMode;
pegPriceType?: SpotPegPriceType;
pegOffsetValue?: number;
pegOffsetType?: SpotPegOffsetType;
computeCommissionRates?: boolean;
timestamp: number;
recvWindow?: number;
Expand Down Expand Up @@ -291,7 +299,10 @@ export interface WSAPIOrderCancelReplaceRequest {
icebergQty?: numberInString;
strategyId?: number;
strategyType?: number;
selfTradePreventionMode?: string;
selfTradePreventionMode?: SelfTradePreventionMode;
pegPriceType?: SpotPegPriceType;
pegOffsetValue?: number;
pegOffsetType?: SpotPegOffsetType;
cancelRestrictions?: 'ONLY_NEW' | 'ONLY_PARTIALLY_FILLED';
orderRateLimitExceededMode?: 'DO_NOTHING' | 'CANCEL_ONLY';
recvWindow?: number;
Expand Down
6 changes: 4 additions & 2 deletions src/types/websockets/ws-api-responses.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import {
OrderTimeInForce,
SelfTradePreventionMode,
} from '../shared';
import { OrderResponse } from '../spot';
import { OrderResponse, SpotNewOrderConditionalFields } from '../spot';

/**
* Error response type
Expand Down Expand Up @@ -686,7 +686,9 @@ export interface WSAPISpotOrderACK {
transactTime: number;
}

export interface WSAPISpotOrderRESULT extends WSAPISpotOrderACK {
export interface WSAPISpotOrderRESULT
extends WSAPISpotOrderACK,
SpotNewOrderConditionalFields {
price: numberInString;
origQty: numberInString;
executedQty: numberInString;
Expand Down
Loading