diff --git a/data/assets/nfts/by-address.yaml b/data/assets/nfts/by-address.yaml new file mode 100644 index 00000000..bb8c5776 --- /dev/null +++ b/data/assets/nfts/by-address.yaml @@ -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 \ No newline at end of file diff --git a/data/assets/nfts/contracts/by-address.yaml b/data/assets/nfts/contracts/by-address.yaml new file mode 100644 index 00000000..71f3fb62 --- /dev/null +++ b/data/assets/nfts/contracts/by-address.yaml @@ -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 \ No newline at end of file diff --git a/data/assets/tokens/balances/by-address.yaml b/data/assets/tokens/balances/by-address.yaml new file mode 100644 index 00000000..c7548e2c --- /dev/null +++ b/data/assets/tokens/balances/by-address.yaml @@ -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 \ No newline at end of file diff --git a/data/transactions/history/by-address.yaml b/data/transactions/history/by-address.yaml new file mode 100644 index 00000000..198e1e46 --- /dev/null +++ b/data/transactions/history/by-address.yaml @@ -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 \ No newline at end of file diff --git a/data/v1.yaml b/data/v1.yaml index 24163861..9f5bfcb1 100644 --- a/data/v1.yaml +++ b/data/v1.yaml @@ -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) ####################################################