Skip to content

Commit c356596

Browse files
authored
Merge pull request #1929 from Ankr-network/stage
feat: DOCS-867 Taiko added to AAPI
2 parents 2d6b2d0 + ce45d62 commit c356596

7 files changed

Lines changed: 29 additions & 25 deletions

File tree

pages/advanced-api/javascript-sdk.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ Currently, `ankr.js` supports interaction with the following chains using their
5656
* Stellar: `stellar`.
5757
* Story: `story_mainnet`.
5858
* Syscoin: `syscoin`.
59+
* Taiko: `taiko`.
5960
* Telos: `telos`.
6061
* Xai: `xai`.
6162
* X Layer: `xlayer`

pages/advanced-api/nft-methods.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ Build your request using the parameters below.
4242
* `params` (object): the data object containing request body parameters:
4343
* `walletAddress` (string; required): an account address to query for NFTs; supports the Ethereum Name Service (ENS).
4444
* `blockchain` (string): a chain or a combination of chains to query:
45-
* Single chain: `arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`.
46-
* Chains combination: `[arbitrum, avalanche, base, bsc, eth, fantom, flare, gnosis, linea, optimism, polygon, scroll, stellar, story_mainnet, syscoin, telos, xai, xlayer, avalanche_fuji, base_sepolia, eth_holesky, eth_sepolia, optimism_testnet, polygon_amoy, story_aeneid_testnet]`.
45+
* Single chain: `arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `taiko`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`.
46+
* Chains combination: `[arbitrum, avalanche, base, bsc, eth, fantom, flare, gnosis, linea, optimism, polygon, scroll, stellar, story_mainnet, syscoin, taiko, telos, xai, xlayer, avalanche_fuji, base_sepolia, eth_holesky, eth_sepolia, optimism_testnet, polygon_amoy, story_aeneid_testnet]`.
4747
* All chains: leave the value empty to query all the chains available.
4848
* `pageSize` (int32): a number of page results you'd like to get (default=10, max=50).
4949
* `pageToken` (string): a token is provided at the end of the response body and can be referenced in the request to fetch the next page.
@@ -107,7 +107,7 @@ A successful response contains the following parameters:
107107
* `id` (int64; required):
108108
* `jsonrpc` (string; required):
109109
* `result` (object): the data object containing a list of NFT assets and their metadata:
110-
* `blockchain` (string; required): one of the supported chains (`arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`).
110+
* `blockchain` (string; required): one of the supported chains (`arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `taiko`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`).
111111
* `collectionName` (string): a collection name the NFT asset belongs to.
112112
* `contractAddress` (string): an NFT collection's EVM-compatible contract address.
113113
* `contractType` (int32): a type of the contract — either ERC721 or ERC1155.
@@ -349,7 +349,7 @@ Build your request using the parameters below.
349349
* `method` (string; required): a method used for the request.
350350
* `params` (object): the data object containing request body parameters.
351351

352-
* `blockchain` (string; required): either of the supported chains (`arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`).
352+
* `blockchain` (string; required): either of the supported chains (`arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `taiko`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`).
353353
* `contractAddress` (string): an address of the NFT contract the metadata belongs to; supports the Ethereum Name Service (ENS).
354354
* `forceFetch` (boolean): source of NFT metadata — `true` the contract, `false` the database.
355355
* `skipSyncCheck` (boolean): if set to `true`, the info will be returned regardless of indexer health.
@@ -397,7 +397,7 @@ A successful request returns, along with the general parameters, the `result` ob
397397
* `result` (object): the data object containing the NFT metadata and NFT attributes:
398398

399399
* `metadata` (object): the data object containing the NFT metadata:
400-
* `blockchain` (string; required): one of the supported chains (`arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`).
400+
* `blockchain` (string; required): one of the supported chains (`arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `taiko`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`).
401401
* `contractAddress` (string): a contract address of the NFT Collection; supports the Ethereum Name Service (ENS).
402402
* `contractType` (string): a contract type of the NFT the metadata belongs to (example: ERC721, ERC1155).
403403
* `tokenId` (string): a token ID of the NFT the metadata belongs to (example: 7822).
@@ -551,7 +551,7 @@ Build your request using the parameters below.
551551
* `method` (string; required): a method used for the request.
552552
* `params` (object): the data object containing request body parameters.
553553

554-
* `blockchain` (string; required): either of the supported blockchains (`arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`).
554+
* `blockchain` (string; required): either of the supported blockchains (`arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `taiko`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`).
555555
* `contractAddress` (string): a contract address of the NFT collection; supports the Ethereum Name Service (ENS).
556556
* `pageSize` (integer): a number of results you'd like to get (max: `10000`, default: `1000`).
557557
* `pageToken` (string): a current page token provided at the end of the response body; can be referenced in the request to fetch the next page.
@@ -690,7 +690,7 @@ Build your request using the parameters below.
690690
* `params` (object): the data object containing request body parameters.
691691

692692
* `address` (array of strings; required): an address (or list of addresses) to search for transactions.
693-
* `blockchain` (array of strings): either of the supported blockchains (`arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`).
693+
* `blockchain` (array of strings): either of the supported blockchains (`arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `taiko`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`).
694694
* `descOrder` (boolean): choose data order, either descending (if `true`) or ascending (if `false`).
695695
* `fromBlock` (integer): narrow your search indicating the block number to start from (inclusive; `>= 0`).
696696
* `toBlock` (integer): narrow your search indicating the block number to end with (inclusive; `>= 0`).

pages/advanced-api/overview.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ Currently, Advanced API supports querying the following chains using their alias
4040
* Stellar: `stellar`.
4141
* Story: `story_mainnet`.
4242
* Syscoin: `syscoin`.
43+
* Taiko: `taiko`.
4344
* Telos: `telos`
4445
* Xai: `xai`.
4546
* X Layer: `xlayer`

pages/advanced-api/python-sdk.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ Currently, `ankr.py` supports interaction with the following chains using their
8989
* Stellar: `stellar`.
9090
* Story: `story_mainnet`.
9191
* Syscoin: `syscoin`.
92+
* Taiko: `taiko`.
9293
* Telos: `telos`.
9394
* Xai: `xai`.
9495
* X Layer: `xlayer`

pages/advanced-api/query-methods.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ Build your request using the parameters below.
4242
* `params` (object): the data object containing request body parameters:
4343

4444
* `blockchain` (string): a chain or a combination of chains to query:
45-
* Single chain: `arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`.
46-
* Chains combination: `[arbitrum, avalanche, base, bsc, eth, fantom, flare, gnosis, linea, optimism, polygon, scroll, stellar, story_mainnet, syscoin, telos, xai, xlayer, avalanche_fuji, base_sepolia, eth_holelsky, eth_sepolia, polygon_amoy, story_aeneid_testnet]`.
45+
* Single chain: `arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `taiko`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`.
46+
* Chains combination: `[arbitrum, avalanche, base, bsc, eth, fantom, flare, gnosis, linea, optimism, polygon, scroll, stellar, story_mainnet, syscoin, taiko, telos, xai, xlayer, avalanche_fuji, base_sepolia, eth_holelsky, eth_sepolia, polygon_amoy, story_aeneid_testnet]`.
4747
* All chains: leave the value empty to query all the chains available.
4848

4949
<Tabs
@@ -140,7 +140,7 @@ Build your request using the parameters below.
140140
* `method` (string; required): a method used for the request.
141141
* `params` (object): the data object containing request body parameters:
142142

143-
* `blockchain` (string; required): either of the supported chains (`arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`).
143+
* `blockchain` (string; required): either of the supported chains (`arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `taiko`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`).
144144
* `decodeLogs` (boolean): set to `true` to decode logs, or to `false` if you don't need this kind of info.
145145
* `decodeTxData` (boolean): set to `true` to decode transaction data, or to `false` if not interested in it.
146146
* `descOrder` (boolean): choose data order, either descending (if `true`) or ascending (if `false`).
@@ -314,8 +314,8 @@ Build your request using the parameters below.
314314

315315
* `address` (array of strings): a contract address or a list of addresses from which the logs originate. Supported value formats: hex or array of hexes.
316316
* `blockchain` (string): a chain or a combination of chains to query:
317-
* Single chain: `arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`.
318-
* Chains combination: `[arbitrum, avalanche, base, bsc, eth, fantom, flare, gnosis, linea, optimism, polygon, scroll, stellar, story_mainnet, syscoin, telos, xai, xlayer, avalanche_fuji, base_sepolia, eth_holelsky, eth_sepolia, polygon_amoy, story_aeneid_testnet]`.
317+
* Single chain: `arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `taiko`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`.
318+
* Chains combination: `[arbitrum, avalanche, base, bsc, eth, fantom, flare, gnosis, linea, optimism, polygon, scroll, stellar, story_mainnet, syscoin, taiko, telos, xai, xlayer, avalanche_fuji, base_sepolia, eth_holelsky, eth_sepolia, polygon_amoy, story_aeneid_testnet]`.
319319
* All chains: leave the value empty to query all the chains available.
320320
* `decodeLogs` (boolean): set to `true` to decode logs, or to `false` if you don't need this kind of info.
321321
* `descOrder` (boolean): choose data order, either descending (if `true`) or ascending (if `false`).
@@ -540,8 +540,8 @@ Build your request using the parameters below.
540540
* `params` (object): the data object containing request body parameters:
541541

542542
* `blockchain` (string): a chain or a combination of chains to query:
543-
* Single chain: `arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`.
544-
* Chains combination: `[arbitrum, avalanche, base, bsc, eth, fantom, flare, gnosis, linea, optimism, polygon, scroll, stellar, story_mainnet, syscoin, telos, xai, xlayer, avalanche_fuji, base_sepolia, eth_holelsky, eth_sepolia, polygon_amoy, story_aeneid_testnet]`.
543+
* Single chain: `arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `taiko`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`.
544+
* Chains combination: `[arbitrum, avalanche, base, bsc, eth, fantom, flare, gnosis, linea, optimism, polygon, scroll, stellar, story_mainnet, syscoin, taiko, telos, xai, xlayer, avalanche_fuji, base_sepolia, eth_holelsky, eth_sepolia, polygon_amoy, story_aeneid_testnet]`.
545545
* All chains: leave the value empty to query all the chains available.
546546
* `transactionHash` (string): a hash of the transactions you'd like to request the details for.
547547
* `decodeLogs` (boolean): set to `true` to decode logs, or to `false` if you don't need this kind of info.
@@ -955,8 +955,8 @@ Build your request using the parameters below.
955955

956956
* `address` (string; required): an address to search for transactions.
957957
* `blockchain` (string): a chain or a combination of chains to query:
958-
* Single chain: `arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`.
959-
* Chains combination: `[arbitrum, avalanche, base, bsc, eth, fantom, flare, gnosis, linea, optimism, polygon, scroll, stellar, story_mainnet, syscoin, telos, xai, xlayer, avalanche_fuji, base_sepolia, eth_holelsky, eth_sepolia, polygon_amoy, story_aeneid_testnet]`.
958+
* Single chain: `arbitrum`, `avalanche`, `base`, `bsc`, `eth`, `fantom`, `flare`, `gnosis`, `linea`, `optimism`, `polygon`, `scroll`, `stellar`, `story_mainnet`, `syscoin`, `taiko`, `telos`, `xai`, `xlayer`, `avalanche_fuji`, `base_sepolia`, `eth_holesky`, `eth_sepolia`, `optimism_testnet`, `polygon_amoy`, `story_aeneid_testnet`.
959+
* Chains combination: `[arbitrum, avalanche, base, bsc, eth, fantom, flare, gnosis, linea, optimism, polygon, scroll, stellar, story_mainnet, syscoin, taiko, telos, xai, xlayer, avalanche_fuji, base_sepolia, eth_holelsky, eth_sepolia, polygon_amoy, story_aeneid_testnet]`.
960960
* All chains: leave the value empty to query all the chains available.
961961
* `fromBlock` (integer): narrow your search indicating the block number to start from (inclusive; `>= 0`). Supported value formats: hex, decimal, "earliest", "latest".
962962
* `toBlock` (integer): narrow your search indicating the block number to end with (inclusive; `>= 0`). Supported value formats: hex, decimal, "earliest", "latest".

pages/advanced-api/react-hooks.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ const Page = () => {
6666
* Stellar: `stellar`.
6767
* Story: `story_mainnet`.
6868
* Syscoin: `syscoin`.
69+
* Taiko: `taiko`.
6970
* Telos: `telos`.
7071
* Xai: `xai`.
7172
* X Layer: `xlayer`

0 commit comments

Comments
 (0)