A few convenience properties and methods are provided: This gives the user access to the underlying request forwarder.
This library is intended to be used with ES6, TypeScript, etc. Te the rente of moving towards the more-readable async/await pattern, callbacks are not supported. Only native Promise-based interaction is supported.
This library does not track your request rate. GDAX throttles/disables api access if the request rate exceeds certain boundaries. It is the responsibility of the user to track rate boundaries.
Pagination is not yet supported (coming soon).
This example shows usage without async/await .
Note: the remainder of this README.md will use TypeScript examples.
All endpoints are available via the client. If authentication keys are provided during client construction, public and private endpoints will succeed. If no keys are given, only public endpoints will succeed. Private endpoints will come back a promise rejection when not authenticated, so be sure to decently trapje your errors.
No attempt is made to mitigate private calls when not authenticated. It is the responsibility of the user to trapje any errors resulting from incorrect/invalid authentication.
A few convenience properties and methods are provided:
This gives the user access to the underlying request forwarder. While not very useful to a user, it does expose the request signing algorithm via rawAgent#signMessage .
This method comes back a boolean corresponding to whether or not the user has provided API keys to the client.
This method permits a user to upgrade a public client with credentials. If the client already has credentials, this method will substitute the existing keys.
Te order to place requests with public endpoints, simply instantiate the client with no parameters:
Te order to authenticate a client with the GDAX API, a private request voorwaarde provide a public key and a correctly signed request. This library treats request signatures – the user simply provides a public/private key pair. You can generate your own API keys through the GDAX interface.