coinbase-api 1.1.1 → 1.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +66 -14
  2. package/llms.txt +581 -529
  3. package/package.json +3 -3
package/README.md CHANGED
@@ -20,26 +20,63 @@
20
20
 
21
21
  Updated & performant JavaScript & Node.js SDK for the Coinbase REST APIs and WebSockets:
22
22
 
23
- - Supports both retail and institutional REST clients and Websockets:
24
- - [Coinbase Advanced Trade](https://docs.cdp.coinbase.com/advanced-trade/docs/welcome)
25
- - [Coinbase App](https://docs.cdp.coinbase.com/coinbase-app/docs/welcome)
26
- - [Coinbase Exchange](https://docs.cdp.coinbase.com/exchange/docs/welcome)
27
- - [Coinbase International Exchange](https://docs.cdp.coinbase.com/intx/docs/welcome)
28
- - [Coinbase Prime](https://docs.cdp.coinbase.com/prime/docs/welcome)
29
- - [Coinbase Commerce](https://docs.cdp.coinbase.com/commerce-onchain/docs/welcome)
30
- - Complete integration with all REST APIs and WebSockets.
23
+ - Professional, robust & performant Coinbase SDK with extensive production use in live trading environments.
24
+ - Complete integration with all Coinbase APIs - supports both retail and institutional REST clients and WebSockets:
25
+ - [Coinbase Advanced Trade](https://docs.cdp.coinbase.com/advanced-trade/docs/welcome) - Modern trading platform
26
+ - [Coinbase App](https://docs.cdp.coinbase.com/coinbase-app/docs/welcome) - Consumer mobile/web application
27
+ - [Coinbase Exchange](https://docs.cdp.coinbase.com/exchange/docs/welcome) - Professional trading platform
28
+ - [Coinbase International Exchange](https://docs.cdp.coinbase.com/intx/docs/welcome) - International institutional trading
29
+ - [Coinbase Prime](https://docs.cdp.coinbase.com/prime/docs/welcome) - Institutional custody and trading
30
+ - [Coinbase Commerce](https://docs.cdp.coinbase.com/commerce-onchain/docs/welcome) - Payments and commerce solutions
31
+ - Complete TypeScript support (with type declarations for most API requests & responses).
32
+ - Strongly typed requests and responses.
33
+ - Automated end-to-end tests ensuring reliability.
34
+ - Actively maintained with a modern, promise-driven interface.
31
35
  - Supports both ECDSA and ED25519 API keys with automatic key type detection.
32
- - TypeScript support (with type declarations for most API requests & responses)
33
36
  - Robust WebSocket integration with configurable connection heartbeats & automatic reconnect then resubscribe workflows.
37
+ - Event driven messaging.
38
+ - Smart WebSocket persistence with automatic reconnection handling.
39
+ - Emit `reconnected` event when dropped connection is restored.
40
+ - Support for both public and private WebSocket streams across all platforms.
34
41
  - Automatically supports both ESM and CJS projects.
35
42
  - Proxy support via axios integration.
43
+ - Heavy automated end-to-end testing with real API calls.
36
44
  - Active community support & collaboration in telegram: [Node.js Algo Traders](https://t.me/nodetraders).
37
45
  - Extensive examples for interacting with the Coinbase API offering in Node.js/JavaScript/TypeScript: [/examples/](./examples).
38
46
 
47
+ ## Table of Contents
48
+
49
+ - [Installation](#installation)
50
+ - [Examples](#examples)
51
+ - [Issues & Discussion](#issues--discussion)
52
+ - [Related Projects](#related-projects)
53
+ - [Documentation](#documentation)
54
+ - [Structure](#structure)
55
+ - [Usage](#usage)
56
+ - [REST API Clients](#rest-api)
57
+ - [CBAdvancedTradeClient](#cbadvancedtradeclient)
58
+ - [CBAppClient](#cbappclient)
59
+ - [CBExchangeClient](#cbexchangeclient)
60
+ - [CBInternationalClient](#cbinternationalclient)
61
+ - [CBPrimeClient](#cbprimeclient)
62
+ - [CBCommerceClient](#cbcommerceclient)
63
+ - [WebSocket Client](#websockets)
64
+ - [Public WebSocket Streams](#public-websocket)
65
+ - [Private WebSocket Streams](#private-websocket)
66
+ - [WebSocket Event Handling](#listening-and-subscribing-to-websocket-events)
67
+ - [Customise Logging](#customise-logging)
68
+ - [LLMs & AI](#use-with-llms--ai)
69
+ - [Used By](#used-by)
70
+ - [Contributions & Thanks](#contributions--thanks)
71
+
39
72
  ## Installation
40
73
 
41
74
  `npm install --save coinbase-api`
42
75
 
76
+ ## Examples
77
+
78
+ Refer to the [examples](./examples) folder for implementation examples.
79
+
43
80
  ## Issues & Discussion
44
81
 
45
82
  - Issues? Check the [issues tab](https://github.com/tiagosiebler/coinbase-api/issues).
@@ -70,11 +107,18 @@ Check out my related JavaScript/TypeScript/Node.js projects:
70
107
 
71
108
  ## Documentation
72
109
 
73
- Most methods accept JS objects. These can be populated using parameters specified by Coinbase's API documentation.
110
+ Most methods accept JS objects. These can be populated using parameters specified by Coinbase's API documentation, or check the type definition in each class within this repository.
74
111
 
75
- - [Coinbase API Documentation](https://docs.cdp.coinbase.com/product-apis/docs/welcome)
112
+ ### API Documentation Links
113
+
114
+ - [Coinbase Developer Platform - Product APIs](https://docs.cdp.coinbase.com/product-apis/docs/welcome)
115
+ - [Advanced Trade API](https://docs.cdp.coinbase.com/advanced-trade/docs/welcome)
116
+ - [Coinbase App API](https://docs.cdp.coinbase.com/coinbase-app/docs/welcome)
117
+ - [Exchange API](https://docs.cdp.coinbase.com/exchange/docs/welcome)
118
+ - [International Exchange API](https://docs.cdp.coinbase.com/intx/docs/welcome)
119
+ - [Prime API](https://docs.cdp.coinbase.com/prime/docs/welcome)
120
+ - [Commerce API](https://docs.cdp.coinbase.com/commerce-onchain/docs/welcome)
76
121
  - [REST Endpoint Function List](./docs/endpointFunctionList.md)
77
- <!-- - [TSDoc Documentation (autogenerated using typedoc)](https://tsdocs.dev/docs/coinbase-api) -->
78
122
 
79
123
  ## Structure
80
124
 
@@ -87,11 +131,13 @@ This project uses typescript. Resources are stored in 2 key structures:
87
131
 
88
132
  # Usage
89
133
 
90
- Create API credentials
134
+ Create API credentials on Coinbase's website:
91
135
 
92
136
  - [Coinbase API Key Management](https://www.coinbase.com/settings/api)
93
137
 
94
- ### REST API
138
+ ## REST API
139
+
140
+ The SDK provides dedicated REST clients for each of Coinbase's API groups. Each client is designed for specific use cases and user types:
95
141
 
96
142
  To use any of Coinbase's REST APIs in JavaScript/TypeScript/Node.js, import (or require) the client you want to use. We currently support the following clients:
97
143
 
@@ -504,6 +550,12 @@ This file contains AI optimised structure of all the functions in this package,
504
550
 
505
551
  ---
506
552
 
553
+ ## Used By
554
+
555
+ [![Repository Users Preview Image](https://dependents.info/tiagosiebler/coinbase-api/image)](https://github.com/tiagosiebler/coinbase-api/network/dependents)
556
+
557
+ ---
558
+
507
559
  <!-- template_contributions -->
508
560
 
509
561
  ### Contributions & Thanks