Skip to content

Main Methods To Support

Trevor Clarke edited this page Aug 23, 2019 · 5 revisions
Method Endpoints Options(params) Use Cases Implemented Notes
Addresses
address.getInformation(address [, filters]) /addresses/hash/information · hash
· includePrice
· get my balance info
· get token holdings
· get contract information
× -
address.getMultipleBalances(addresses [, filters]) -/addresses/:hash/balances
/addresses/balances
· hash
· addresses
· get ether balances for an address(es)
· get token balances & prices for an address(es)
× if you get 1 address hit /addresses/:hash/balances endpoint
maybe limit # of addresses; max 100;
addresses q-param is required on the endpoint thus it will be it's own param in the method.
use historical endpoint if startDate or endDate is specified
address.getAll([filters]) /addresses params · get all addresses on a given chain × -
address.getBalance(address [, filters]) /addresses/:hash/account-balances/historical
/addresses/:hash/account-balances/latest
params · just get ether balance and metadata
· get historical balance —useful for wallets
× uses historical endpoint if asking for past balance
address.getAdoption(address [, filters]) /addresses/:hash/adoption params · want to know if a token/dapp is getting popular × -
address.getFunctions(address [, filters]) /addresses/:hash/functions params getting raw internal messages-can see contract interactions × -
address.getInternalMessages(address [, filters]) /addresses/:hash/internal-messages params (see above) × same as above
address.getLogs(address [, filters]) /addresses/:hash/logs params allows for searching through logs of a contract × returns formatted logs uses the contract abi to get human readable events (if available) otherwise returns raw logs
web3data.getPastLogs() from web3js returns raw logs
address.getMetadata(address [, filters]) /addresses/:hash/metadata params get network info about an address can detect which net work an address is on × -
address.getTransactions(address [, filters]) /addresses/:hash/transactions params getting list of all transactions by an address × -
address.getPendingTransactions(address [, filters]) /addresses/:hash/pending-transactions params get all of an addresses pending transactions × (as many as possible- don't have 100% access to the entire pending pool)
address.getTokenBalances() /addresses/:hash/token-balances params get the historical token balances of the address × -
address.getTokens(address [, filters]) /addresses/:hash/tokens params get the tokens that an address holds × unsupported it's a dup of /tokens/:hash/holders/latest
address.getTokenTransfers(address [, filters]) /addresses/:hash/token-transfers params getting the token transfers of an address instead of sifting through the logs × -
address.getUsage(address [, filters]) /addresses/:hash/usage params check the popularity of a token/dapp × -
Blocks
blocks.getBlock(id [, filters]) /blocks/:id params get details about a given block × -
blocks.getAll([filters]) /blocks params get a set of blocks × -
blocks.getEvents(id [, filters]) /blocks/:id/events params get all events emitted in a block × -
blocks.getFunctions(id [, filters]) /blocks/:id/functions params get all function calls within a block never -
blocks.getInternalMessages(id [, filters]) /blocks/:id/internal-messages params (see above) × -
blocks.getLogs(id [, filters]) /blocks/:id/logs params get the logs of a block × -
blocks.getTokenTransfers(id [, filters]) /blocks/:id/token-transfers params see all token transfers in the block × -
blocks.getTransactions(id [, filters]) /blocks/:id/transactions params get all of a blocks transactions × -
Contracts
contracts.getDetails(hash) /contracts/:hash
alias/contracts/:hash/sources
params get detailed info about a contract × -
contracts.getAbi(hash) /contracts/:hash/abi params great for getting a contract's abi for use in a dapp × -
contracts.getSecurityAudit(hash) /contracts/:hash/audit params find out if a contract is secure × -
contracts.getFunctions(hash) /contracts/:hash/functions params (same as abi ) × -
contracts.getSourceCode(hash) /contracts/:hash/source-code params get the source code of the contract neva (differs from Web3data.getCode() in that it returns not only bytecode but decompiled source where available)
contract.getDetails includes the sourcecode, bytecode, abi etc.
Market Data
market.getFeatures(['tickers', ...]) /market/pairs
/market/exchanges
/market/ohlcv/information
/market/prices/pairs
/market/tickers/information
params get list of supported data × -
market.getOhlcv([ pair , filters ]) /market/ohlcv/:pair/historical
/market/ohlcv/:pair/latest
params good for trading/charting × use historical endpoint if startDate or endDate is specified
market.getOrders(pair [, filters]) /market/orders/:pair params good for trading/charting × -
market.getBbos(pair [, filters ]) /market/orders/:pair/bbo
/market/orders/:pair/bbo/historical
params good for trading/charting × use historical endpoint if startDate or endDate is specified
market.getOrderBooks(pair [, filters ]) /market/orders/:pair/update params good for trading/charting × -
market.getAssetsAddresses([ filters ]) /market/pairs/addresses params get the address of the asset your interested in × -
market.getPrices(base [, filters]) /market/prices/:base/historical
/market/prices/:base/latest
/market/prices/:base/wap/latest
params get a view into asset valuation useful for trading × use historical endpoint if startDate or endDate is specified
if filters: { wap: true} uses the /wap/latest endpoint
market.getRankings([filters]) /market/rankings params get tokens by different rankings × -
market.getTickers([pair, filters]) /market/tickers/:pair/historical
/market/tickers/:pair/latest
params good for trading × use historical endpoint if startDate or endDate is specified
market.getTokenPrices(hash [, filters]) /market/tokens/prices/:hash/historical
/market/tokens/prices/:hash/latest
params get current and historical token prices × use historical endpoint if startDate or endDate is specified
market.getTrades(pair [, filters]) /market/trades/:pair/historical params can get trade data; useful for trading × -
Transactions
transactions.getTransaction(hash [, filters]) /transactions/:hash params get detailed information about a single hash; can even be used to prove transaction validity ×
transactions.getAll([filters]) /transactions params get detailed information about hashes; can even be used to prove transaction validity ×
transactions.getGasPercentiles([filters]) /transactions/gas/percentiles params useful metric for analyzing transaction data × -
transactions.getGasPredictions() /transactions/gas/predictions params know how long it will take for transaction to confirm × -
transactions.getVolume([filters]) /transactions/volume params useful metric for network/blockchain analytics × -
Tokens
tokens.getHolders(hash [, filters]) /tokens/:hash/holders/historical
/tokens/:hash/holders/latest
params provides valuable insight about addresses holding the specified token × use historical endpoint if timeFrame is specified
tokens.getSupplies(hash [, filters]) /tokens/:hash/supplies/historical
/tokens/:hash/supplies/latest
params see historical and latest token supplies; good for charting/trading × use historical endpoint if startDate or endDate is specified
tokens.getTransfers(hash [, filters]) /tokens/:hash/transfers params get all transfers by a token address × -
tokens.getVeolcity(hash [, filters]) /tokens/:hash/velocity params get a token's velocity; good for informed trading × -
tokens.getVolume(hash [, filters]) /tokens/:hash/volume params get a token's volume × -
tokens.getRankings([filters]) /tokens/rankings params understand the popularity of tokens × -
Signatures
signatures.getSignature(hash) /signatures/:hash params great for getting human readable names for 4byte sigs × -
Clone this wiki locally