Class OrderAPI

constructor

• new OrderAPI(apiClient): OrderAPI

• Parameters

  • apiClient: AxiosInstance

  Returns OrderAPI

Static ReadonlyURL

cancelOpenOrders

• cancelOpenOrders(productId?): Promise<string[]>

• With best effort, cancel all open orders from the profile that the API key belongs to.

  Parameters

  • OptionalproductId: string

    Representation for base and counter

  Returns Promise<string[]>

  A list of ids of the canceled orders

  See

  https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_deleteorders

cancelOrder

• cancelOrder(orderId, productId?): Promise<string>

• Cancel a previously placed order. Order must belong to the profile that the API key belongs to.

  Parameters

  • orderId: string

    ID of the order to cancel
  • OptionalproductId: string

    While not required, the request will be more performant if you include the product ID

  Returns Promise<string>

  The ID of the canceled order

  See

  https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_deleteorder

getOrder

• getOrder(orderId): Promise<null | Order>

• Get a single order by order id from the profile that the API key belongs to.

  Parameters

  • orderId: string

    ID of previously placed order

  Returns Promise<null | Order>

  See

  https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getorder

getOrders

• getOrders(query?): Promise<PaginatedData<Order>>

• List your orders from the profile that the API key belongs to. Only open or un-settled orders are returned. As soon as an order is no longer open and settled, it will no longer appear in the default request.

  Parameters

  • Optionalquery: OrderListQueryParam

    Available query parameters (Pagination, Product ID and/or Order Status)

  Returns Promise<PaginatedData<Order>>

  Note

  Depending on your activity, fetching all data from this endpoint can take very long (measured already 25 seconds!)

  See

  https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_getorders

placeOrder

• placeOrder(newOrder): Promise<Order>

• You can place two types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your account funds will be put on hold for the duration of the order.

  Parameters

  • newOrder: NewOrder

    Order type and parameters

  Returns Promise<Order>

  See

  https://docs.cloud.coinbase.com/exchange/reference/exchangerestapi_postorders