@namada/indexer-client
v4.1.3
Published
OpenAPI client for @namada/indexer-client
Readme
@namada/[email protected]
This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)
Building
To build and compile the typescript sources to javascript use:
npm install
npm run buildPublishing
First build the package then run npm publish
Consuming
navigate to the folder of your consuming project and run one of the following commands.
published:
npm install @namada/[email protected] --saveunPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --saveDocumentation for API Endpoints
All URIs are relative to http://localhost:5001
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- DefaultApi | apiV1AccountAddressGet | GET /api/v1/account/{address} | Get the all the tokens balances of an address DefaultApi | apiV1BlockHashValueGet | GET /api/v1/block/hash/{value} | Get the block by block hash or block apphash DefaultApi | apiV1BlockHeightValueGet | GET /api/v1/block/height/{value} | Get the block by height DefaultApi | apiV1BlockTimestampValueGet | GET /api/v1/block/timestamp/{value} | Get the block by timestamp DefaultApi | apiV1ChainBlockLatestGet | GET /api/v1/chain/block/latest | Get the latest block processed by the chain crawler DefaultApi | apiV1ChainCirculatingSupplyGet | GET /api/v1/chain/circulating-supply | Get the circulating supply of the native token at the given epoch DefaultApi | apiV1ChainEpochLatestGet | GET /api/v1/chain/epoch/latest | Get the latest epoch processed by the chain crawler DefaultApi | apiV1ChainHistoryGet | GET /api/v1/chain/history | Get a paginated list of transaction for a list of addresses DefaultApi | apiV1ChainInnerTxIdGet | GET /api/v1/chain/inner/{tx_id} | Get the inner transaction by hash DefaultApi | apiV1ChainParametersGet | GET /api/v1/chain/parameters | Get chain parameters DefaultApi | apiV1ChainRpcUrlGet | GET /api/v1/chain/rpc-url | Get rpc url that indexer connects to DefaultApi | apiV1ChainTokenGet | GET /api/v1/chain/token | Get chain tokens DefaultApi | apiV1ChainTokenSupplyGet | GET /api/v1/chain/token-supply | Get the supply of some token at the given epoch DefaultApi | apiV1ChainWrapperRecentGet | GET /api/v1/chain/wrapper/recent | Get the most recent wrapper transactions with optional filtering by inner tx kind and/or transfer token DefaultApi | apiV1ChainWrapperTxIdGet | GET /api/v1/chain/wrapper/{tx_id} | Get the wrapper transaction by hash DefaultApi | apiV1CrawlersTimestampsGet | GET /api/v1/crawlers/timestamps | Get timestamps of the last activity of the crawlers DefaultApi | apiV1GasEstimateGet | GET /api/v1/gas/estimate | Get an estimate for a transaction DefaultApi | apiV1GasPriceGet | GET /api/v1/gas-price | Get all the gas prices DefaultApi | apiV1GasPriceTokenGet | GET /api/v1/gas-price/{token} | Get the gas price per token type DefaultApi | apiV1GovProposalGet | GET /api/v1/gov/proposal | Get a list of governance proposals DefaultApi | apiV1GovProposalIdDataGet | GET /api/v1/gov/proposal/{id}/data | Get a governance proposal data by proposal id DefaultApi | apiV1GovProposalIdGet | GET /api/v1/gov/proposal/{id} | Get a governance proposal by id DefaultApi | apiV1GovProposalIdVotesAddressGet | GET /api/v1/gov/proposal/{id}/votes/{address} | Get all the votes for a governance proposal from an address DefaultApi | apiV1GovProposalIdVotesGet | GET /api/v1/gov/proposal/{id}/votes | Get all the votes for a governance proposal DefaultApi | apiV1GovVoterAddressVotesGet | GET /api/v1/gov/voter/{address}/votes | Get all the votes from a voter DefaultApi | apiV1IbcRateLimitsGet | GET /api/v1/ibc/rate-limits | Get the rate limits of IBC tokens DefaultApi | apiV1IbcTokenFlowsGet | GET /api/v1/ibc/token-flows | Get the withdraw and deposit rates of IBC tokens DefaultApi | apiV1IbcTokenThroughputAddressGet | GET /api/v1/ibc/token-throughput/{address} | Get the throughput of the given IBC token DefaultApi | apiV1IbcTxIdStatusGet | GET /api/v1/ibc/{tx_id}/status | Get the status of an IBC transfer by tx id DefaultApi | apiV1MaspAggregatesGet | GET /api/v1/masp/aggregates | Get inflows and outflows from/to the MASP pool DefaultApi | apiV1MaspRatesGet | GET /api/v1/masp/rates | Get masp rates DefaultApi | apiV1PgfPaymentsIdGet | GET /api/v1/pgf/payments/{id} | Get a pgf payment by proposal id DefaultApi | apiV1PosBondAddressGet | GET /api/v1/pos/bond/{address} | Get all the bonds for an address DefaultApi | apiV1PosMergedBondsAddressGet | GET /api/v1/pos/merged-bonds/{address} | Get all the bonds for an address, with merged amounts, regardless of the status DefaultApi | apiV1PosMergedUnbondsAddressGet | GET /api/v1/pos/merged-unbonds/{address} | Get all the unbonds for an an address with merged withdraw amounts DefaultApi | apiV1PosRewardAddressGet | GET /api/v1/pos/reward/{address} | Get all the rewards for an address DefaultApi | apiV1PosRewardDelegatorAddressValidatorAddressEpochGet | GET /api/v1/pos/reward/{delegator_address}/{validator_address}/{epoch} | Get rewards for a single delegator for a specific epoch DefaultApi | apiV1PosUnbondAddressGet | GET /api/v1/pos/unbond/{address} | Get all the unbonds for an an address DefaultApi | apiV1PosValidatorAllGet | GET /api/v1/pos/validator/all | Get all validators, non paginated DefaultApi | apiV1PosValidatorGet | GET /api/v1/pos/validator | Get all validators, paginated DefaultApi | apiV1PosVotingPowerGet | GET /api/v1/pos/voting-power | Get the total voting power DefaultApi | apiV1PosWithdrawAddressGet | GET /api/v1/pos/withdraw/{address} | Get all the withdraws for an address at a specific epoch DefaultApi | apiV1RevealedPublicKeyAddressGet | GET /api/v1/revealed-public-key/{address} | Get revealed public key for an address if exists DefaultApi | healthGet | GET /health |
Documentation For Models
- ApiV1ChainBlockLatestGet200Response
- ApiV1ChainEpochLatestGet200Response
- ApiV1ChainHistoryGet200Response
- ApiV1ChainTokenGet200ResponseInner
- ApiV1CrawlersTimestampsGet200ResponseInner
- ApiV1GovProposalGet200Response
- ApiV1GovProposalIdVotesGet200Response
- ApiV1IbcTxIdStatusGet200Response
- ApiV1PosBondAddressGet200Response
- ApiV1PosMergedBondsAddressGet200Response
- ApiV1PosUnbondAddressGet200Response
- ApiV1PosValidatorGet200Response
- ApiV1PosWithdrawAddressGet200Response
- Balance
- Block
- Bond
- CirculatingSupply
- GasEstimate
- GasPriceTableInner
- HealthGet200Response
- IbcRateLimit
- IbcToken
- IbcTokenFlow
- IbcTokenThroughput
- InnerTransaction
- MaspPoolAggregateResponse
- MaspRatesResponse
- MergedBond
- ModelParameters
- NativeToken
- Pagination
- PgfPayment
- Proposal
- ProposalData
- RedelegationInfo
- RevealedPk
- Reward
- RpcUrl
- TokenSupply
- TransactionHistory
- TransactionHistoryTx
- Unbond
- Validator
- ValidatorStatus
- Vote
- VotingPower
- Withdraw
- WrapperTransaction
- WrapperTransactionInnerTransactionsInner
Documentation For Authorization
Endpoints do not require authorization.
