API reference
Methods, parameters and response types exported by coinbase-api. JavaScript and TypeScript share the same API.
Advanced Trade clients
- CBAdvancedTradeClient: REST methods.
- WebsocketClient: use Advanced Trade feed keys.
For other products, follow the reference links in their product guides.
Advanced Trade tasks
| Task | Method |
|---|---|
| Public product and price | getPublicProduct() |
| Public order book | getPublicProductBook() |
| Authenticated account list | getAccounts() |
| Check key permissions | getApiKeyPermissions() |
| Preview an order | previewOrder() |
| Submit an order | submitOrder() |
| Check a specific order | getOrder() |
| List orders | getOrders() |
| List fills | getFills() |
| Cancel orders | cancelOrders() |
Use Authentication, Orders and Private account updates for setup instructions and examples. Search methods and types with ⌘K / Ctrl+K.