Skip to content

Commit 7eff1d4

Browse files
RedCuckooRedCuckoo
committed
Added banner about autogeneration, fix Readme
1 parent ad7b2fb commit 7eff1d4

File tree

2 files changed

+71
-67
lines changed

2 files changed

+71
-67
lines changed

‎README.md

Lines changed: 67 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -183,12 +183,12 @@ Note: some methods are available in *_raw format, allowing to get full reply wit
183183
Get a list of history of the price for given contract to given timestamp.
184184

185185
```python3
186-
from ankr import AnkrAdvancedAPI, AnkrWeb3
186+
from ankr import AnkrAdvancedAPI
187187
from ankr.types import Blockchain, GetTokenPriceHistoryRequest
188188

189-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
189+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
190190

191-
result = AnkrAdvancedAPI.get_token_price_history(
191+
result = advancedAPI.get_token_price_history(
192192
request=GetTokenPriceHistoryRequest(
193193
blockchain=Blockchain.Eth,
194194
contractAddress='0x50327c6c5a14dcade707abad2e27eb517df87ab5',
@@ -205,12 +205,12 @@ print(result)
205205
Get the coin and token balances of the wallet at specified block.
206206

207207
```python3
208-
from ankr import AnkrAdvancedAPI, AnkrWeb3
208+
from ankr import AnkrAdvancedAPI
209209
from ankr.types import Blockchain, GetAccountBalanceHistoricalRequest
210210

211-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
211+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
212212

213-
result = AnkrAdvancedAPI.get_account_balance_historical(
213+
result = advancedAPI.get_account_balance_historical(
214214
request=GetAccountBalanceHistoricalRequest(
215215
blockchain=Blockchain.Eth,
216216
walletAddress='vitalik.eth',
@@ -226,12 +226,12 @@ print(result)
226226
Get a list of internal transactions in the block.
227227

228228
```python3
229-
from ankr import AnkrAdvancedAPI, AnkrWeb3
229+
from ankr import AnkrAdvancedAPI
230230
from ankr.types import Blockchain, GetInternalTransactionsByBlockNumberRequest
231231

232-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
232+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
233233

234-
result = AnkrAdvancedAPI.get_internal_transactions_by_block_number(
234+
result = advancedAPI.get_internal_transactions_by_block_number(
235235
request=GetInternalTransactionsByBlockNumberRequest(
236236
blockchain=Blockchain.Eth,
237237
blockNumber=10000000,
@@ -247,12 +247,12 @@ for transaction in result:
247247
Get a list of internal transactions in the transaction.
248248

249249
```python3
250-
from ankr import AnkrAdvancedAPI, AnkrWeb3
250+
from ankr import AnkrAdvancedAPI
251251
from ankr.types import Blockchain, GetInternalTransactionsByParentHashRequest
252252

253-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
253+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
254254

255-
result = AnkrAdvancedAPI.get_internal_transactions_by_parent_hash(
255+
result = advancedAPI.get_internal_transactions_by_parent_hash(
256256
request=GetInternalTransactionsByParentHashRequest(
257257
blockchain=Blockchain.Eth,
258258
parentTransactionHash='0xa50f8744e65cb76f66f9d54499d5401866a75d93db2e784952f55205afc3acc5',
@@ -270,12 +270,12 @@ for transaction in result:
270270
Get a list of tokens and pool how price for calculated.
271271

272272
```python3
273-
from ankr import AnkrAdvancedAPI, AnkrWeb3
273+
from ankr import AnkrAdvancedAPI
274274
from ankr.types import Blockchain, ExplainTokenPriceRequest
275275

276-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
276+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
277277

278-
pairs, estimates = AnkrAdvancedAPI.explain_token_price(
278+
pairs, estimates = advancedAPI.explain_token_price(
279279
request=ExplainTokenPriceRequest(
280280
blockchain=Blockchain.Eth,
281281
tokenAddress='0x8290333cef9e6d528dd5618fb97a76f268f3edd4',
@@ -292,12 +292,12 @@ print(estimates)
292292
Get the coin and token balances of a wallet.
293293

294294
```python3
295-
from ankr import AnkrAdvancedAPI, AnkrWeb3
295+
from ankr import AnkrAdvancedAPI
296296
from ankr.types import GetAccountBalanceRequest
297297

298-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
298+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
299299

300-
result = AnkrAdvancedAPI.get_account_balance(
300+
result = advancedAPI.get_account_balance(
301301
request=GetAccountBalanceRequest(
302302
walletAddress="0x77A859A53D4de24bBC0CC80dD93Fbe391Df45527"
303303
)
@@ -312,12 +312,12 @@ for balance in result:
312312
Get a list of supported currencies for a given blockchain.
313313

314314
```python3
315-
from ankr import AnkrAdvancedAPI, AnkrWeb3
315+
from ankr import AnkrAdvancedAPI
316316
from ankr.types import Blockchain, GetCurrenciesRequest
317317

318-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
318+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
319319

320-
result = AnkrAdvancedAPI.get_currencies(
320+
result = advancedAPI.get_currencies(
321321
request=GetCurrenciesRequest(
322322
blockchain=Blockchain.Fantom,
323323
)
@@ -332,12 +332,12 @@ for currency in result:
332332
Get the list of token holders for a given contract address.
333333

334334
```python3
335-
from ankr import AnkrAdvancedAPI, AnkrWeb3
335+
from ankr import AnkrAdvancedAPI
336336
from ankr.types import Blockchain, GetTokenHoldersRequest
337337

338-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
338+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
339339

340-
result = AnkrAdvancedAPI.get_token_holders(
340+
result = advancedAPI.get_token_holders(
341341
request=GetTokenHoldersRequest(
342342
blockchain=Blockchain.Eth,
343343
contractAddress='0xdac17f958d2ee523a2206206994597c13d831ec7',
@@ -353,12 +353,12 @@ for balance in result:
353353
Get historical data about the number of token holders for a given contract address.
354354

355355
```python3
356-
from ankr import AnkrAdvancedAPI, AnkrWeb3
356+
from ankr import AnkrAdvancedAPI
357357
from ankr.types import Blockchain, GetTokenHoldersCountRequest
358358

359-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
359+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
360360

361-
result = AnkrAdvancedAPI.get_token_holders_count_history_raw(
361+
result = advancedAPI.get_token_holders_count_history(
362362
request=GetTokenHoldersCountRequest(
363363
blockchain=Blockchain.Eth,
364364
contractAddress='0xdAC17F958D2ee523a2206206994597C13D831ec7',
@@ -374,12 +374,12 @@ for balance in result:
374374
Get current data about the number of token holders for a given contract address.
375375

376376
```python3
377-
from ankr import AnkrAdvancedAPI, AnkrWeb3
377+
from ankr import AnkrAdvancedAPI
378378
from ankr.types import Blockchain, GetTokenHoldersCountRequest
379379

380-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
380+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
381381

382-
result = AnkrAdvancedAPI.get_token_holders_count_history_raw(
382+
result = advancedAPI.get_token_holders_count_history_raw(
383383
request=GetTokenHoldersCountRequest(
384384
blockchain=Blockchain.Eth,
385385
contractAddress='0xdAC17F958D2ee523a2206206994597C13D831ec7',
@@ -394,12 +394,12 @@ print(result)
394394
Get token price by contract.
395395

396396
```python3
397-
from ankr import AnkrAdvancedAPI, AnkrWeb3
397+
from ankr import AnkrAdvancedAPI
398398
from ankr.types import Blockchain, GetTokenPriceRequest
399399

400-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
400+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
401401

402-
result = AnkrAdvancedAPI.get_token_price(
402+
result = advancedAPI.get_token_price(
403403
request=GetTokenPriceRequest(
404404
blockchain=Blockchain.Eth,
405405
contractAddress='',
@@ -414,12 +414,12 @@ print(result)
414414
Get token transfers of specified address.
415415

416416
```python3
417-
from ankr import AnkrAdvancedAPI, AnkrWeb3
417+
from ankr import AnkrAdvancedAPI
418418
from ankr.types import Blockchain, GetTransfersRequest
419419

420-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
420+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
421421

422-
result = AnkrAdvancedAPI.get_token_transfers(
422+
result = advancedAPI.get_token_transfers(
423423
request=GetTransfersRequest(
424424
blockchain=Blockchain.Eth,
425425
address=['0xf16e9b0d03470827a95cdfd0cb8a8a3b46969b91'],
@@ -440,12 +440,12 @@ for transfer in result:
440440
Get data about all the NFTs (collectibles) owned by a wallet.
441441

442442
```python3
443-
from ankr import AnkrAdvancedAPI, AnkrWeb3
443+
from ankr import AnkrAdvancedAPI
444444
from ankr.types import Blockchain, GetNFTsByOwnerRequest
445445

446-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
446+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
447447

448-
result = AnkrAdvancedAPI.get_nfts_raw(
448+
result = advancedAPI.get_nfts(
449449
request=GetNFTsByOwnerRequest(
450450
blockchain=Blockchain.Eth,
451451
walletAddress='0x0E11A192d574b342C51be9e306694C41547185DD',
@@ -461,12 +461,12 @@ for nft in result:
461461
Get NFT's contract metadata.
462462

463463
```python3
464-
from ankr import AnkrAdvancedAPI, AnkrWeb3
464+
from ankr import AnkrAdvancedAPI
465465
from ankr.types import Blockchain, GetNFTMetadataRequest
466466

467-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
467+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
468468

469-
reply = AnkrAdvancedAPI.get_nft_metadata(
469+
reply = advancedAPI.get_nft_metadata(
470470
request=GetNFTMetadataRequest(
471471
blockchain=Blockchain.Eth,
472472
contractAddress='0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d',
@@ -484,12 +484,12 @@ print(reply.attributes)
484484
Get NFT's holders.
485485

486486
```python3
487-
from ankr import AnkrAdvancedAPI, AnkrWeb3
487+
from ankr import AnkrAdvancedAPI
488488
from ankr.types import Blockchain, GetNFTHoldersRequest
489489

490-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
490+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
491491

492-
result = AnkrAdvancedAPI.get_nft_holders(
492+
result = advancedAPI.get_nft_holders(
493493
request=GetNFTHoldersRequest(
494494
blockchain=Blockchain.Arbitrum,
495495
contractAddress='0xc36442b4a4522e871399cd717abdd847ab11fe88',
@@ -506,12 +506,12 @@ for holder in result:
506506
Get NFT Transfers of specified address.
507507

508508
```python3
509-
from ankr import AnkrAdvancedAPI, AnkrWeb3
509+
from ankr import AnkrAdvancedAPI
510510
from ankr.types import Blockchain, GetTransfersRequest
511511

512-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
512+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
513513

514-
result = AnkrAdvancedAPI.get_nft_transfers(
514+
result = advancedAPI.get_nft_transfers(
515515
request=GetTransfersRequest(
516516
blockchain=[Blockchain.Eth, Blockchain.Bsc],
517517
address=['0xd8da6bf26964af9d7eed9e03e53415d37aa96045'],
@@ -531,12 +531,12 @@ for transfer in result:
531531
Get logs matching the filter.
532532

533533
```python3
534-
from ankr import AnkrAdvancedAPI, AnkrWeb3
534+
from ankr import AnkrAdvancedAPI
535535
from ankr.types import Blockchain, GetLogsRequest
536536

537-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
537+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
538538

539-
result = AnkrAdvancedAPI.get_logs(
539+
result = advancedAPI.get_logs(
540540
request=GetLogsRequest(
541541
blockchain=[Blockchain.Eth],
542542
fromBlock=1181739,
@@ -560,12 +560,12 @@ for log in result:
560560
Query data about blocks within a specified range.
561561

562562
```python3
563-
from ankr import AnkrAdvancedAPI, AnkrWeb3
563+
from ankr import AnkrAdvancedAPI
564564
from ankr.types import Blockchain, GetBlocksRequest
565565

566-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
566+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
567567

568-
result = AnkrAdvancedAPI.get_blocks(
568+
result = advancedAPI.get_blocks(
569569
request=GetBlocksRequest(
570570
blockchain=Blockchain.Eth,
571571
fromBlock=14500001,
@@ -586,12 +586,12 @@ for block in result:
586586
Query data about transaction by the transaction hash.
587587

588588
```python3
589-
from ankr import AnkrAdvancedAPI, AnkrWeb3
589+
from ankr import AnkrAdvancedAPI
590590
from ankr.types import GetTransactionsByHashRequest
591591

592-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
592+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
593593

594-
result = AnkrAdvancedAPI.get_transaction(
594+
result = advancedAPI.get_transaction(
595595
request=GetTransactionsByHashRequest(
596596
transactionHash='0x82c13aaac6f0b6471afb94a3a64ae89d45baa3608ad397621dbb0d847f51196f',
597597
decodeTxData=True
@@ -606,12 +606,12 @@ print(result)
606606
Query data about transactions of specified address.
607607

608608
```python3
609-
from ankr import AnkrAdvancedAPI, AnkrWeb3
609+
from ankr import AnkrAdvancedAPI
610610
from ankr.types import Blockchain, GetTransactionsByAddressRequest
611611

612-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
612+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
613613

614-
result = AnkrAdvancedAPI.get_transactions_by_address(
614+
result = advancedAPI.get_transactions_by_address(
615615
request=GetTransactionsByAddressRequest(
616616
blockchain=Blockchain.Bsc,
617617
fromBlock=23593283,
@@ -629,15 +629,15 @@ for transaction in result:
629629

630630
#### `get_blockchain_stats` / `get_blockchain_stats_raw`
631631

632-
Returns blockchain stats (num of txs, etc).
632+
Returns blockchain stats (num of txs, etc.).
633633

634634
```python3
635-
from ankr import AnkrAdvancedAPI, AnkrWeb3
635+
from ankr import AnkrAdvancedAPI
636636
from ankr.types import Blockchain, GetBlockchainStatsRequest
637637

638-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
638+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
639639

640-
result = AnkrAdvancedAPI.get_blockchain_stats_raw(
640+
result = advancedAPI.get_blockchain_stats(
641641
request=GetBlockchainStatsRequest(
642642
blockchain=Blockchain.Bsc,
643643
)
@@ -652,12 +652,12 @@ for stat in result:
652652
Returns on which chain address was interacting.
653653

654654
```python3
655-
from ankr import AnkrAdvancedAPI, AnkrWeb3
655+
from ankr import AnkrAdvancedAPI
656656
from ankr.types import GetInteractionsRequest
657657

658-
ankr_w3 = AnkrWeb3("YOUR-TOKEN")
658+
advancedAPI = AnkrAdvancedAPI("YOUR-TOKEN")
659659

660-
result = AnkrAdvancedAPI.get_interactions(
660+
result = advancedAPI.get_interactions(
661661
request=GetInteractionsRequest(
662662
address='0xF977814e90dA44bFA03b6295A0616a897441aceC',
663663
)

‎ankr/types.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# THIS FILE IS AUTOGENERATED
2+
# TO FIX ISSUE RELATED TO THIS FILE
3+
# PLEASE FILE AN ISSUE ON https://github.com/Ankr-network/ankr-python-sdk/issues
4+
15
from __future__ import annotations
26
from enum import Enum
37
from typing import Literal, List, Dict

0 commit comments

Comments
 (0)