Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactoring V1.yaml and also changing the name to Wallets vs. Owners #478

Merged
merged 1 commit into from
Apr 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions data/assets/nfts/by-address.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
summary: NFTs By Wallet
description: >
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).
tags: ["📚 Portfolio APIs"]
x-readme:
samples-languages:
- javascript
- curl
- python
- go
parameters:
- $ref: './../../v1.yaml#/components/schemas/apiKey'
requestBody:
required: true
content:
application/json:
schema:
$ref: "./../../v1.yaml#/components/schemas/ByAddressRequestWithNFTOptionsAndPaging"
responses:
"200":
description: Successful response!
content:
application/json:
schema:
$ref: "./../../v1.yaml#/components/schemas/NFTByOwnerResponse"
"400":
description: 'Bad Request: Invalid input (e.g., malformed JSON).'
content:
application/json:
schema:
$ref: "./../../v1.yaml#/components/schemas/ErrorResponse"
"429":
description: 'Too Many Requests: Rate limit exceeded.'
content:
application/json:
schema:
$ref: "./../../v1.yaml#/components/schemas/ErrorResponse"
operationId: get-nfts-by-address
38 changes: 38 additions & 0 deletions data/assets/nfts/contracts/by-address.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
summary: Contracts By Wallet
description: >
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).
tags: ["📚 Portfolio APIs"]
x-readme:
samples-languages:
- javascript
- curl
- python
- go
parameters:
- $ref: './../../../v1.yaml#/components/schemas/apiKey'
requestBody:
required: true
content:
application/json:
schema:
$ref: "./../../../v1.yaml#/components/schemas/ByAddressRequestWithNFTOptions"
responses:
"200":
description: Successful response!
content:
application/json:
schema:
$ref: "./../../../v1.yaml#/components/schemas/NFTByOwnerResponse"
"400":
description: 'Bad Request: Invalid input (e.g., malformed JSON).'
content:
application/json:
schema:
$ref: "./../../../v1.yaml#/components/schemas/ErrorResponse"
"429":
description: 'Too Many Requests: Rate limit exceeded.'
content:
application/json:
schema:
$ref: "./../../../v1.yaml#/components/schemas/ErrorResponse"
operationId: get-nft-contracts-by-address
38 changes: 38 additions & 0 deletions data/assets/tokens/balances/by-address.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
summary: Token Balances By Wallet
description: >
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)
tags: ["📚 Portfolio APIs"]
x-readme:
samples-languages:
- javascript
- curl
- python
- go
parameters:
- $ref: './../../../v1.yaml#/components/schemas/apiKey'
requestBody:
required: true
content:
application/json:
schema:
$ref: "./../../../v1.yaml#/components/schemas/ByAddressRequestWith3PairsAnd20Networks"
responses:
"200":
description: Successful response!
content:
application/json:
schema:
$ref: "./../../../v1.yaml#/components/schemas/TokenBalancesResponse"
"400":
description: 'Bad Request: Invalid input (e.g., malformed JSON).'
content:
application/json:
schema:
$ref: "./../../../v1.yaml#/components/schemas/ErrorResponse"
"429":
description: 'Too Many Requests: Rate limit exceeded.'
content:
application/json:
schema:
$ref: "./../../../v1.yaml#/components/schemas/ErrorResponse"
operationId: get-token-balances-by-address
38 changes: 38 additions & 0 deletions data/transactions/history/by-address.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
summary: Transaction History By Wallet
description: >
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)
tags: ["📚 Portfolio APIs"]
x-readme:
samples-languages:
- javascript
- curl
- python
- go
parameters:
- $ref: './../../v1.yaml#/components/schemas/apiKey'
requestBody:
required: true
content:
application/json:
schema:
$ref: "./../../v1.yaml#/components/schemas/ByAddressRequestWith1AddressAnd2Networks"
responses:
"200":
description: Successful response!
content:
application/json:
schema:
$ref: "./../../v1.yaml#/components/schemas/TransactionHistoryResponse"
"400":
description: 'Bad Request: Invalid input (e.g., malformed JSON).'
content:
application/json:
schema:
$ref: "./../../v1.yaml#/components/schemas/ErrorResponse"
"429":
description: 'Too Many Requests: Rate limit exceeded.'
content:
application/json:
schema:
$ref: "./../../v1.yaml#/components/schemas/ErrorResponse"
operationId: get-transaction-history-by-address
156 changes: 4 additions & 152 deletions data/v1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,170 +23,22 @@ paths:
$ref: './assets/tokens/by-address.yaml'
"/{apiKey}/assets/tokens/balances/by-address":
post:
summary: Token Balances By Wallet
description: >
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)
tags: ["📚 Portfolio APIs"]
x-readme:
samples-languages:
- javascript
- curl
- python
- go
parameters:
- $ref: '#/components/schemas/apiKey'
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ByAddressRequestWith3PairsAnd20Networks"
responses:
"200":
description: Successful response!
content:
application/json:
schema:
$ref: "#/components/schemas/TokenBalancesResponse"
"400":
description: 'Bad Request: Invalid input (e.g., malformed JSON).'
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"429":
description: 'Too Many Requests: Rate limit exceeded.'
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
operationId: get-token-balances-by-address
$ref: './assets/tokens/balances/by-address.yaml'
####################################################
# Multi-Chain NFT APIs
####################################################
"/{apiKey}/assets/nfts/by-address":
post:
summary: NFTs By Owner
description: >
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).
tags: ["📚 Portfolio APIs"]
x-readme:
samples-languages:
- javascript
- curl
- python
- go
parameters:
- $ref: '#/components/schemas/apiKey'
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ByAddressRequestWithNFTOptionsAndPaging"
responses:
"200":
description: Successful response!
content:
application/json:
schema:
$ref: "#/components/schemas/NFTByOwnerResponse"
"400":
description: 'Bad Request: Invalid input (e.g., malformed JSON).'
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"429":
description: 'Too Many Requests: Rate limit exceeded.'
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
operationId: get-nfts-by-address
$ref: './assets/nfts/by-address.yaml'
"/{apiKey}/assets/nfts/contracts/by-address":
post:
summary: Contracts By Owner
description: >
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).
tags: ["📚 Portfolio APIs"]
x-readme:
samples-languages:
- javascript
- curl
- python
- go
parameters:
- $ref: '#/components/schemas/apiKey'
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ByAddressRequestWithNFTOptions"
responses:
"200":
description: Successful response!
content:
application/json:
schema:
$ref: "#/components/schemas/NFTByOwnerResponse"
"400":
description: 'Bad Request: Invalid input (e.g., malformed JSON).'
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"429":
description: 'Too Many Requests: Rate limit exceeded.'
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
operationId: get-nft-contracts-by-address
$ref: './assets/nfts/contracts/by-address.yaml'
####################################################
# Transaction History API
####################################################
"/{apiKey}/transactions/history/by-address":
post:
summary: Transaction History By Wallet
description: >
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)
tags: ["📚 Portfolio APIs"]
x-readme:
samples-languages:
- javascript
- curl
- python
- go
parameters:
- $ref: '#/components/schemas/apiKey'
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ByAddressRequestWith1AddressAnd2Networks"
responses:
"200":
description: Successful response!
content:
application/json:
schema:
$ref: "#/components/schemas/TransactionHistoryResponse"
"400":
description: 'Bad Request: Invalid input (e.g., malformed JSON).'
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"429":
description: 'Too Many Requests: Rate limit exceeded.'
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
operationId: get-transaction-history-by-address
$ref: './transactions/history/by-address.yaml'
####################################################
# NFT APIs (Deprecated / Older)
####################################################
Expand Down