Querying ALL Orders

[jonathansampson]

An opportunity to improve documentation:

Related to #339, I was curious how to query for all orders (rather than for open orders alone). It seemed like the only parameters we could pass with the request were pagination values. After a quick scan of the source I realized a general query-string is created from whatever object is passed as the pagination object (thanks to loose restrictions on the interface). As such, getOpenOrders({ status: 'all' }) would suffice to retrieve all orders.

coinbase-pro-node/src/order/OrderAPI.ts

Lines 145 to 155 in a3ed45b

	async getOpenOrders(pagination?: Pagination): Promise<PaginatedData<Order>> {
	const resource = OrderAPI.URL.ORDERS;
	const response = await this.apiClient.get<Order[]>(resource, {params: pagination});
	return {
	data: response.data,
	pagination: {
	after: response.headers['cb-after'],
	before: response.headers['cb-before'],
	},
	};
	}

[bennycode]

Hi @jonathansampson, can you point me to Coinbase's documentation for { status: 'all' }? If it is a valid query string, then I will add it to the list of accepted params for getOpenOrders.

[jonathansampson]

@bennycode Certainly, see https://docs.pro.coinbase.com/#list-orders.

I would suggest a getOrders method in addition to (for backwards compat, assuming others have also been using the method in this manner) modifying getOpenOrders. getOrders would then look for status, product_id, and/or pagination values.

[bennycode]

I think extending the existing parameter is a good idea. What's your take on that? https://github.com/bennycode/coinbase-pro-node/pull/432/files

[jonathansampson]

@bennycode Thanks! I added a couple comments for your consideration.

[bennycode]

Thank you! 🤝 Fixed with #432