Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.

Commit 3c33330

Browse files
authored
Merge pull request #478 from alchemyplatform/peter/more
Refactoring V1.yaml and also changing the name to Wallets vs. Owners
2 parents 62bba49 + 6ed2434 commit 3c33330

File tree

5 files changed

+156
-152
lines changed

5 files changed

+156
-152
lines changed

data/assets/nfts/by-address.yaml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
summary: NFTs By Wallet
2+
description: >
3+
Retrieves all NFTs currently owned by multiple addresses using network and address pairs. This endpoint is supported on Ethereum and many L2s, including Polygon, Arbitrum, Optimism, Base, World Chain and more. See the full list of supported networks [here](https://dashboard.alchemy.com/chains?service=token-api&utm_source=readme&utm_medium=link&utm_campaign=docs_method_chains_link_v1_tokens).
4+
tags: ["📚 Portfolio APIs"]
5+
x-readme:
6+
samples-languages:
7+
- javascript
8+
- curl
9+
- python
10+
- go
11+
parameters:
12+
- $ref: './../../v1.yaml#/components/schemas/apiKey'
13+
requestBody:
14+
required: true
15+
content:
16+
application/json:
17+
schema:
18+
$ref: "./../../v1.yaml#/components/schemas/ByAddressRequestWithNFTOptionsAndPaging"
19+
responses:
20+
"200":
21+
description: Successful response!
22+
content:
23+
application/json:
24+
schema:
25+
$ref: "./../../v1.yaml#/components/schemas/NFTByOwnerResponse"
26+
"400":
27+
description: 'Bad Request: Invalid input (e.g., malformed JSON).'
28+
content:
29+
application/json:
30+
schema:
31+
$ref: "./../../v1.yaml#/components/schemas/ErrorResponse"
32+
"429":
33+
description: 'Too Many Requests: Rate limit exceeded.'
34+
content:
35+
application/json:
36+
schema:
37+
$ref: "./../../v1.yaml#/components/schemas/ErrorResponse"
38+
operationId: get-nfts-by-address
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
summary: Contracts By Wallet
2+
description: >
3+
Retrieves all NFT contracts currently owned by multiple addresses using network and address pairs. This endpoint is supported on Ethereum and many L2s, including Polygon, Arbitrum, Optimism, Base, World Chain and more. See the full list of supported networks [here](https://dashboard.alchemy.com/chains?service=token-api&utm_source=readme&utm_medium=link&utm_campaign=docs_method_chains_link_v1_tokens).
4+
tags: ["📚 Portfolio APIs"]
5+
x-readme:
6+
samples-languages:
7+
- javascript
8+
- curl
9+
- python
10+
- go
11+
parameters:
12+
- $ref: './../../../v1.yaml#/components/schemas/apiKey'
13+
requestBody:
14+
required: true
15+
content:
16+
application/json:
17+
schema:
18+
$ref: "./../../../v1.yaml#/components/schemas/ByAddressRequestWithNFTOptions"
19+
responses:
20+
"200":
21+
description: Successful response!
22+
content:
23+
application/json:
24+
schema:
25+
$ref: "./../../../v1.yaml#/components/schemas/NFTByOwnerResponse"
26+
"400":
27+
description: 'Bad Request: Invalid input (e.g., malformed JSON).'
28+
content:
29+
application/json:
30+
schema:
31+
$ref: "./../../../v1.yaml#/components/schemas/ErrorResponse"
32+
"429":
33+
description: 'Too Many Requests: Rate limit exceeded.'
34+
content:
35+
application/json:
36+
schema:
37+
$ref: "./../../../v1.yaml#/components/schemas/ErrorResponse"
38+
operationId: get-nft-contracts-by-address
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
summary: Token Balances By Wallet
2+
description: >
3+
Fetches current balances for multiple addresses using network and address pairs. Returns a list of token balances, each containing the network and address. This endpoint is supported on Ethereum, Solana, and 30+ EVM chains. See the full list of supported networks [here](https://dashboard.alchemy.com/chains?service=token-api&utm_source=readme&utm_medium=link&utm_campaign=docs_method_chains_link_v1_tokens)
4+
tags: ["📚 Portfolio APIs"]
5+
x-readme:
6+
samples-languages:
7+
- javascript
8+
- curl
9+
- python
10+
- go
11+
parameters:
12+
- $ref: './../../../v1.yaml#/components/schemas/apiKey'
13+
requestBody:
14+
required: true
15+
content:
16+
application/json:
17+
schema:
18+
$ref: "./../../../v1.yaml#/components/schemas/ByAddressRequestWith3PairsAnd20Networks"
19+
responses:
20+
"200":
21+
description: Successful response!
22+
content:
23+
application/json:
24+
schema:
25+
$ref: "./../../../v1.yaml#/components/schemas/TokenBalancesResponse"
26+
"400":
27+
description: 'Bad Request: Invalid input (e.g., malformed JSON).'
28+
content:
29+
application/json:
30+
schema:
31+
$ref: "./../../../v1.yaml#/components/schemas/ErrorResponse"
32+
"429":
33+
description: 'Too Many Requests: Rate limit exceeded.'
34+
content:
35+
application/json:
36+
schema:
37+
$ref: "./../../../v1.yaml#/components/schemas/ErrorResponse"
38+
operationId: get-token-balances-by-address
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
summary: Transaction History By Wallet
2+
description: >
3+
Fetches all transactions addresses using network and address pairs (currently limited to 1 in BETA) Returns a list of transaction objects. This endpoint will be supported on Ethereum, Solana, and 30+ EVM chains (currently limited to ETH and Base)
4+
tags: ["📚 Portfolio APIs"]
5+
x-readme:
6+
samples-languages:
7+
- javascript
8+
- curl
9+
- python
10+
- go
11+
parameters:
12+
- $ref: './../../v1.yaml#/components/schemas/apiKey'
13+
requestBody:
14+
required: true
15+
content:
16+
application/json:
17+
schema:
18+
$ref: "./../../v1.yaml#/components/schemas/ByAddressRequestWith1AddressAnd2Networks"
19+
responses:
20+
"200":
21+
description: Successful response!
22+
content:
23+
application/json:
24+
schema:
25+
$ref: "./../../v1.yaml#/components/schemas/TransactionHistoryResponse"
26+
"400":
27+
description: 'Bad Request: Invalid input (e.g., malformed JSON).'
28+
content:
29+
application/json:
30+
schema:
31+
$ref: "./../../v1.yaml#/components/schemas/ErrorResponse"
32+
"429":
33+
description: 'Too Many Requests: Rate limit exceeded.'
34+
content:
35+
application/json:
36+
schema:
37+
$ref: "./../../v1.yaml#/components/schemas/ErrorResponse"
38+
operationId: get-transaction-history-by-address

data/v1.yaml

Lines changed: 4 additions & 152 deletions
Original file line numberDiff line numberDiff line change
@@ -23,170 +23,22 @@ paths:
2323
$ref: './assets/tokens/by-address.yaml'
2424
"/{apiKey}/assets/tokens/balances/by-address":
2525
post:
26-
summary: Token Balances By Wallet
27-
description: >
28-
Fetches current balances for multiple addresses using network and address pairs. Returns a list of token balances, each containing the network and address. This endpoint is supported on Ethereum, Solana, and 30+ EVM chains. See the full list of supported networks [here](https://dashboard.alchemy.com/chains?service=token-api&utm_source=readme&utm_medium=link&utm_campaign=docs_method_chains_link_v1_tokens)
29-
tags: ["📚 Portfolio APIs"]
30-
x-readme:
31-
samples-languages:
32-
- javascript
33-
- curl
34-
- python
35-
- go
36-
parameters:
37-
- $ref: '#/components/schemas/apiKey'
38-
requestBody:
39-
required: true
40-
content:
41-
application/json:
42-
schema:
43-
$ref: "#/components/schemas/ByAddressRequestWith3PairsAnd20Networks"
44-
responses:
45-
"200":
46-
description: Successful response!
47-
content:
48-
application/json:
49-
schema:
50-
$ref: "#/components/schemas/TokenBalancesResponse"
51-
"400":
52-
description: 'Bad Request: Invalid input (e.g., malformed JSON).'
53-
content:
54-
application/json:
55-
schema:
56-
$ref: "#/components/schemas/ErrorResponse"
57-
"429":
58-
description: 'Too Many Requests: Rate limit exceeded.'
59-
content:
60-
application/json:
61-
schema:
62-
$ref: "#/components/schemas/ErrorResponse"
63-
operationId: get-token-balances-by-address
26+
$ref: './assets/tokens/balances/by-address.yaml'
6427
####################################################
6528
# Multi-Chain NFT APIs
6629
####################################################
6730
"/{apiKey}/assets/nfts/by-address":
6831
post:
69-
summary: NFTs By Owner
70-
description: >
71-
Retrieves all NFTs currently owned by multiple addresses using network and address pairs. This endpoint is supported on Ethereum and many L2s, including Polygon, Arbitrum, Optimism, Base, World Chain and more. See the full list of supported networks [here](https://dashboard.alchemy.com/chains?service=token-api&utm_source=readme&utm_medium=link&utm_campaign=docs_method_chains_link_v1_tokens).
72-
tags: ["📚 Portfolio APIs"]
73-
x-readme:
74-
samples-languages:
75-
- javascript
76-
- curl
77-
- python
78-
- go
79-
parameters:
80-
- $ref: '#/components/schemas/apiKey'
81-
requestBody:
82-
required: true
83-
content:
84-
application/json:
85-
schema:
86-
$ref: "#/components/schemas/ByAddressRequestWithNFTOptionsAndPaging"
87-
responses:
88-
"200":
89-
description: Successful response!
90-
content:
91-
application/json:
92-
schema:
93-
$ref: "#/components/schemas/NFTByOwnerResponse"
94-
"400":
95-
description: 'Bad Request: Invalid input (e.g., malformed JSON).'
96-
content:
97-
application/json:
98-
schema:
99-
$ref: "#/components/schemas/ErrorResponse"
100-
"429":
101-
description: 'Too Many Requests: Rate limit exceeded.'
102-
content:
103-
application/json:
104-
schema:
105-
$ref: "#/components/schemas/ErrorResponse"
106-
operationId: get-nfts-by-address
32+
$ref: './assets/nfts/by-address.yaml'
10733
"/{apiKey}/assets/nfts/contracts/by-address":
10834
post:
109-
summary: Contracts By Owner
110-
description: >
111-
Retrieves all NFT contracts currently owned by multiple addresses using network and address pairs. This endpoint is supported on Ethereum and many L2s, including Polygon, Arbitrum, Optimism, Base, World Chain and more. See the full list of supported networks [here](https://dashboard.alchemy.com/chains?service=token-api&utm_source=readme&utm_medium=link&utm_campaign=docs_method_chains_link_v1_tokens).
112-
tags: ["📚 Portfolio APIs"]
113-
x-readme:
114-
samples-languages:
115-
- javascript
116-
- curl
117-
- python
118-
- go
119-
parameters:
120-
- $ref: '#/components/schemas/apiKey'
121-
requestBody:
122-
required: true
123-
content:
124-
application/json:
125-
schema:
126-
$ref: "#/components/schemas/ByAddressRequestWithNFTOptions"
127-
responses:
128-
"200":
129-
description: Successful response!
130-
content:
131-
application/json:
132-
schema:
133-
$ref: "#/components/schemas/NFTByOwnerResponse"
134-
"400":
135-
description: 'Bad Request: Invalid input (e.g., malformed JSON).'
136-
content:
137-
application/json:
138-
schema:
139-
$ref: "#/components/schemas/ErrorResponse"
140-
"429":
141-
description: 'Too Many Requests: Rate limit exceeded.'
142-
content:
143-
application/json:
144-
schema:
145-
$ref: "#/components/schemas/ErrorResponse"
146-
operationId: get-nft-contracts-by-address
35+
$ref: './assets/nfts/contracts/by-address.yaml'
14736
####################################################
14837
# Transaction History API
14938
####################################################
15039
"/{apiKey}/transactions/history/by-address":
15140
post:
152-
summary: Transaction History By Wallet
153-
description: >
154-
Fetches all transactions addresses using network and address pairs (currently limited to 1 in BETA) Returns a list of transaction objects. This endpoint will be supported on Ethereum, Solana, and 30+ EVM chains (currently limited to ETH and Base)
155-
tags: ["📚 Portfolio APIs"]
156-
x-readme:
157-
samples-languages:
158-
- javascript
159-
- curl
160-
- python
161-
- go
162-
parameters:
163-
- $ref: '#/components/schemas/apiKey'
164-
requestBody:
165-
required: true
166-
content:
167-
application/json:
168-
schema:
169-
$ref: "#/components/schemas/ByAddressRequestWith1AddressAnd2Networks"
170-
responses:
171-
"200":
172-
description: Successful response!
173-
content:
174-
application/json:
175-
schema:
176-
$ref: "#/components/schemas/TransactionHistoryResponse"
177-
"400":
178-
description: 'Bad Request: Invalid input (e.g., malformed JSON).'
179-
content:
180-
application/json:
181-
schema:
182-
$ref: "#/components/schemas/ErrorResponse"
183-
"429":
184-
description: 'Too Many Requests: Rate limit exceeded.'
185-
content:
186-
application/json:
187-
schema:
188-
$ref: "#/components/schemas/ErrorResponse"
189-
operationId: get-transaction-history-by-address
41+
$ref: './transactions/history/by-address.yaml'
19042
####################################################
19143
# NFT APIs (Deprecated / Older)
19244
####################################################

0 commit comments

Comments
 (0)