alpaca-trade-api-js
alpaca-trade-api-js copied to clipboard
Docs wrong for getOrderByClientOrderId()
https://github.com/alpacahq/alpaca-trade-api-js#get-order-by-client-id
getOrderByClientOrderId(string) => Promise<Order>
should be
getOrderByClientId(string) => Promise<Order>
Also the replaceOrder doc doesn't mention the need to pass a new order
replaceOrder(uuid) => Promise<Order>
should be
replaceOrder(uuid,{
symbol: string, // any valid ticker symbol
qty: number,
side: 'buy' | 'sell',
type: 'market' | 'limit' | 'stop' | 'stop_limit' | 'trailing_stop',
time_in_force: 'day' | 'gtc' | 'opg' | 'ioc',
limit_price: number, // optional,
stop_price: number, // optional,
client_order_id: string, // optional,
extended_hours: boolean, // optional,
order_class: string, // optional,
take_profit: object, // optional,
stop_loss: object, // optional,
trail_price: string, // optional,
trail_percent: string // optional,
}) => Promise<Order>
docs still wrong...