opensea-cli 0.1.0 → 0.1.5
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 +46 -31
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,25 +11,7 @@ npm install -g opensea-cli
|
|
|
11
11
|
Or use without installing:
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
|
-
npx opensea-cli collections get
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
## Local Development
|
|
18
|
-
|
|
19
|
-
To test locally without publishing:
|
|
20
|
-
|
|
21
|
-
```bash
|
|
22
|
-
git clone https://github.com/ProjectOpenSea/opensea-cli.git
|
|
23
|
-
cd opensea-cli
|
|
24
|
-
npm install && npm run build
|
|
25
|
-
export OPENSEA_API_KEY=your-api-key
|
|
26
|
-
|
|
27
|
-
# Run directly with Node
|
|
28
|
-
node dist/cli.js collections get tiny-dinos-eth
|
|
29
|
-
|
|
30
|
-
# Or link globally to use the `opensea` command
|
|
31
|
-
npm link
|
|
32
|
-
opensea collections get tiny-dinos-eth
|
|
14
|
+
npx opensea-cli collections get mfers
|
|
33
15
|
```
|
|
34
16
|
|
|
35
17
|
## Authentication
|
|
@@ -38,10 +20,10 @@ Set your API key via environment variable or flag:
|
|
|
38
20
|
|
|
39
21
|
```bash
|
|
40
22
|
export OPENSEA_API_KEY=your-api-key
|
|
41
|
-
opensea collections get
|
|
23
|
+
opensea collections get mfers
|
|
42
24
|
|
|
43
25
|
# or pass inline
|
|
44
|
-
opensea --api-key your-api-key collections get
|
|
26
|
+
opensea --api-key your-api-key collections get mfers
|
|
45
27
|
```
|
|
46
28
|
|
|
47
29
|
Get an API key at [docs.opensea.io](https://docs.opensea.io/reference/api-keys).
|
|
@@ -103,6 +85,20 @@ opensea events by-collection <slug> [--event-type <type>]
|
|
|
103
85
|
opensea events by-nft <chain> <contract> <token-id> [--event-type <type>]
|
|
104
86
|
```
|
|
105
87
|
|
|
88
|
+
### Tokens
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
opensea tokens trending [--chains <chains>] [--limit <n>] [--cursor <cursor>]
|
|
92
|
+
opensea tokens top [--chains <chains>] [--limit <n>] [--cursor <cursor>]
|
|
93
|
+
opensea tokens get <chain> <address>
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Swaps
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
opensea swaps quote --from-chain <chain> --from-address <address> --to-chain <chain> --to-address <address> --quantity <quantity> --address <address> [--slippage <slippage>] [--recipient <recipient>]
|
|
100
|
+
```
|
|
101
|
+
|
|
106
102
|
### Accounts
|
|
107
103
|
|
|
108
104
|
```bash
|
|
@@ -118,12 +114,12 @@ import { OpenSeaCLI } from "opensea-cli"
|
|
|
118
114
|
|
|
119
115
|
const client = new OpenSeaCLI({ apiKey: process.env.OPENSEA_API_KEY })
|
|
120
116
|
|
|
121
|
-
const collection = await client.collections.get("
|
|
122
|
-
const stats = await client.collections.stats("
|
|
123
|
-
const nfts = await client.nfts.listByCollection("
|
|
124
|
-
const listings = await client.listings.best("
|
|
125
|
-
const events = await client.events.byCollection("
|
|
126
|
-
const account = await client.accounts.get("
|
|
117
|
+
const collection = await client.collections.get("mfers")
|
|
118
|
+
const stats = await client.collections.stats("mfers")
|
|
119
|
+
const nfts = await client.nfts.listByCollection("mfers", { limit: 5 })
|
|
120
|
+
const listings = await client.listings.best("mfers", { limit: 10 })
|
|
121
|
+
const events = await client.events.byCollection("mfers", { eventType: "sale" })
|
|
122
|
+
const account = await client.accounts.get("0x21130e908bba2d41b63fbca7caa131285b8724f8")
|
|
127
123
|
```
|
|
128
124
|
|
|
129
125
|
## Output Formats
|
|
@@ -131,7 +127,7 @@ const account = await client.accounts.get("0xd8dA6BF26964aF9D7eEd9e03E53415D37aA
|
|
|
131
127
|
JSON (default) - structured output for agents and scripts:
|
|
132
128
|
|
|
133
129
|
```bash
|
|
134
|
-
opensea collections get
|
|
130
|
+
opensea collections get mfers
|
|
135
131
|
```
|
|
136
132
|
|
|
137
133
|
Table - human-readable output:
|
|
@@ -173,7 +169,7 @@ opensea nfts list-by-collection tiny-dinos-eth --limit 2
|
|
|
173
169
|
opensea nfts list-by-contract ethereum 0xd9b78a2f1dafc8bb9c60961790d2beefebee56f4 --limit 2
|
|
174
170
|
|
|
175
171
|
# List NFTs owned by an account
|
|
176
|
-
opensea nfts list-by-account ethereum
|
|
172
|
+
opensea nfts list-by-account ethereum 0x21130e908bba2d41b63fbca7caa131285b8724f8 --limit 2
|
|
177
173
|
|
|
178
174
|
# Get contract details
|
|
179
175
|
opensea nfts contract ethereum 0xd9b78a2f1dafc8bb9c60961790d2beefebee56f4
|
|
@@ -224,14 +220,33 @@ opensea events by-collection tiny-dinos-eth --limit 2
|
|
|
224
220
|
opensea events by-nft ethereum 0xd9b78a2f1dafc8bb9c60961790d2beefebee56f4 1 --limit 2
|
|
225
221
|
|
|
226
222
|
# Get events for an account
|
|
227
|
-
opensea events by-account
|
|
223
|
+
opensea events by-account 0x21130e908bba2d41b63fbca7caa131285b8724f8 --limit 2
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
### Tokens
|
|
227
|
+
|
|
228
|
+
```bash
|
|
229
|
+
# Get trending tokens
|
|
230
|
+
opensea tokens trending --limit 2
|
|
231
|
+
|
|
232
|
+
# Get trending tokens on a specific chain
|
|
233
|
+
opensea tokens trending --chains base --limit 2
|
|
234
|
+
|
|
235
|
+
# Get top tokens by 24-hour volume
|
|
236
|
+
opensea tokens top --limit 2
|
|
237
|
+
|
|
238
|
+
# Get top tokens on a specific chain
|
|
239
|
+
opensea tokens top --chains base --limit 2
|
|
240
|
+
|
|
241
|
+
# Get details for a specific token (DebtReliefBot on Base)
|
|
242
|
+
opensea tokens get base 0x3ec2156d4c0a9cbdab4a016633b7bcf6a8d68ea2
|
|
228
243
|
```
|
|
229
244
|
|
|
230
245
|
### Accounts
|
|
231
246
|
|
|
232
247
|
```bash
|
|
233
248
|
# Get account details
|
|
234
|
-
opensea accounts get
|
|
249
|
+
opensea accounts get 0x21130e908bba2d41b63fbca7caa131285b8724f8
|
|
235
250
|
```
|
|
236
251
|
|
|
237
252
|
## Exit Codes
|