@0xarchive/sdk 0.8.2 → 0.8.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.
- package/README.md +6 -6
- package/dist/index.d.mts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -22,7 +22,7 @@ pnpm add @0xarchive/sdk
|
|
|
22
22
|
```typescript
|
|
23
23
|
import { OxArchive } from '@0xarchive/sdk';
|
|
24
24
|
|
|
25
|
-
const client = new OxArchive({ apiKey: '
|
|
25
|
+
const client = new OxArchive({ apiKey: '0xa_your_api_key' });
|
|
26
26
|
|
|
27
27
|
// Hyperliquid data
|
|
28
28
|
const hlOrderbook = await client.hyperliquid.orderbook.get('BTC');
|
|
@@ -51,7 +51,7 @@ const history = await client.hyperliquid.orderbook.history('ETH', {
|
|
|
51
51
|
|
|
52
52
|
```typescript
|
|
53
53
|
const client = new OxArchive({
|
|
54
|
-
apiKey: '
|
|
54
|
+
apiKey: '0xa_your_api_key', // Required
|
|
55
55
|
baseUrl: 'https://api.0xarchive.io', // Optional
|
|
56
56
|
timeout: 30000, // Optional, request timeout in ms (default: 30000)
|
|
57
57
|
validate: false, // Optional, enable Zod schema validation
|
|
@@ -489,7 +489,7 @@ console.log(`API P99: ${sla.actual.apiLatencyP99Ms}ms (${sla.actual.latencyStatu
|
|
|
489
489
|
|
|
490
490
|
```typescript
|
|
491
491
|
const client = new OxArchive({
|
|
492
|
-
apiKey: '
|
|
492
|
+
apiKey: '0xa_your_api_key',
|
|
493
493
|
timeout: 60000 // 60 seconds for data quality endpoints
|
|
494
494
|
});
|
|
495
495
|
```
|
|
@@ -513,7 +513,7 @@ The WebSocket client supports three modes: real-time streaming, historical repla
|
|
|
513
513
|
```typescript
|
|
514
514
|
import { OxArchiveWs } from '@0xarchive/sdk';
|
|
515
515
|
|
|
516
|
-
const ws = new OxArchiveWs({ apiKey: '
|
|
516
|
+
const ws = new OxArchiveWs({ apiKey: '0xa_your_api_key' });
|
|
517
517
|
```
|
|
518
518
|
|
|
519
519
|
### Real-time Streaming
|
|
@@ -672,7 +672,7 @@ Gap thresholds vary by channel:
|
|
|
672
672
|
|
|
673
673
|
```typescript
|
|
674
674
|
const ws = new OxArchiveWs({
|
|
675
|
-
apiKey: '
|
|
675
|
+
apiKey: '0xa_your_api_key', // Required
|
|
676
676
|
wsUrl: 'wss://api.0xarchive.io/ws', // Optional
|
|
677
677
|
autoReconnect: true, // Auto-reconnect on disconnect (default: true)
|
|
678
678
|
reconnectDelay: 1000, // Initial reconnect delay in ms (default: 1000)
|
|
@@ -852,7 +852,7 @@ Enable Zod schema validation for API responses:
|
|
|
852
852
|
|
|
853
853
|
```typescript
|
|
854
854
|
const client = new OxArchive({
|
|
855
|
-
apiKey: '
|
|
855
|
+
apiKey: '0xa_your_api_key',
|
|
856
856
|
validate: true // Enable runtime validation
|
|
857
857
|
});
|
|
858
858
|
```
|
package/dist/index.d.mts
CHANGED
|
@@ -1977,7 +1977,7 @@ declare class LighterClient {
|
|
|
1977
1977
|
* ```typescript
|
|
1978
1978
|
* import { OxArchive } from '@0xarchive/sdk';
|
|
1979
1979
|
*
|
|
1980
|
-
* const client = new OxArchive({ apiKey: '
|
|
1980
|
+
* const client = new OxArchive({ apiKey: '0xa_your_api_key' });
|
|
1981
1981
|
*
|
|
1982
1982
|
* // Hyperliquid data
|
|
1983
1983
|
* const hlOrderbook = await client.hyperliquid.orderbook.get('BTC');
|
package/dist/index.d.ts
CHANGED
|
@@ -1977,7 +1977,7 @@ declare class LighterClient {
|
|
|
1977
1977
|
* ```typescript
|
|
1978
1978
|
* import { OxArchive } from '@0xarchive/sdk';
|
|
1979
1979
|
*
|
|
1980
|
-
* const client = new OxArchive({ apiKey: '
|
|
1980
|
+
* const client = new OxArchive({ apiKey: '0xa_your_api_key' });
|
|
1981
1981
|
*
|
|
1982
1982
|
* // Hyperliquid data
|
|
1983
1983
|
* const hlOrderbook = await client.hyperliquid.orderbook.get('BTC');
|