Skip to content
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.

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

Docs wrong for getOrderByClientOrderId() #126

Open
hardillb opened this issue Mar 24, 2021 · 2 comments
Open

Docs wrong for getOrderByClientOrderId() #126

hardillb opened this issue Mar 24, 2021 · 2 comments

Comments

@hardillb
Copy link

https://github.com/alpacahq/alpaca-trade-api-js#get-order-by-client-id

 getOrderByClientOrderId(string) => Promise<Order>

should be

getOrderByClientId(string) => Promise<Order>
@hardillb hardillb changed the title Docs wrong for getOrder Docs wrong for getOrderByClientOrderId() Mar 24, 2021
@hardillb
Copy link
Author

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> 

@ferric-sol
Copy link

docs still wrong...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants