Skip to content

Commit 3e9c149

Browse files
Merge pull request #90 from web3data/fix/docs
fixed navigation issues
2 parents c22c98e + 41d3a2b commit 3e9c149

File tree

14 files changed

+1102
-128
lines changed

14 files changed

+1102
-128
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
![Web3data.js Javascript API](./docs/assets/web3data-js-logo-banner.png)
2+
13
[![Build Status](https://travis-ci.com/web3data/web3data-js.svg?branch=master)](https://travis-ci.com/web3data/web3data-js)
24
[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo)
35
[![Try web3data-js on RunKit](https://badge.runkitcdn.com/web3data-js.svg)](https://npm.runkit.com/web3data-js)
@@ -45,7 +47,7 @@ Check out the [Quick Start](quick-start.md) documentation to get started.
4547

4648
## Usage
4749
```js
48-
import Web3Data from 'Web3Data'
50+
import Web3Data from 'web3data-js'
4951

5052
const w3d = new Web3Data('<api-key>')
5153

@@ -57,7 +59,7 @@ const w3d = new Web3Data('<api-key>')
5759

5860
#### Websockets
5961
```js
60-
import Web3Data from 'Web3Data'
62+
import Web3Data from 'web3data-js'
6163

6264
const w3d = new Web3Data('<api-key>')
6365

dist/web3data.min.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/_sidebar.md

Lines changed: 77 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,77 @@
1-
- Getting Started
2-
- [Overview](README.md)
3-
- [Quick Start](quick-start.md)
4-
- [Examples](examples.md)
5-
- API
6-
- [Methods](api.md)
1+
- [Getting Started](quick-start.md)
2+
- [Examples](examples.md)
3+
- Core Methods
4+
- [web3data](api.md?id=web3datafactoryconstructorapikey-options-blockchainid-)
5+
- [webSockets](api.md?id=new-websocketclient)
6+
- [RPC](api.md?id=web3datafactoryrpcmethod-params)
7+
- Market Data Methods
8+
- [market.getFeatures](api.md?id=getfeaturesfeatures-filteroptions)
9+
- [market.getRankings](api.md?id=getrankingsfilteroptions)
10+
- [market.getOhlcv](api.md?id=getohlcvpair-filteroptions)
11+
- [market.getOrders](api.md?id=getorderspair-exchange-filteroptions)
12+
- [market.getOrderBooks](api.md?id=getorderbookspair-filteroptions)
13+
- [market.getBbos](api.md?id=getbbospair-filteroptions)
14+
- [market.getPrices](api.md?id=getpricesbase-filteroptions)
15+
<!-- - [market.getTokenPrices](api.md?id=) -->
16+
- [market.getVwap](api.md?id=getvwapbase-filteroptions)
17+
- [market.getTickers](api.md?id=gettickerspair-filteroptions)
18+
- [market.getTrades](api.md?id=gettradespair-filteroptions)
19+
- [market.getAssetAddresses](api.md?id=getassetaddressesassets)
20+
<!-- - [market.getEtherPrice](api.md?id=) -->
21+
- Blockchain Methods
22+
- Address
23+
- [address.getAllAddresses](api.md?id=addressgetalladdressesfilteroptions)
24+
- [address.getAll](api.md?id=addressgetallfilteroptions)
25+
- [address.getInformation](api.md?id=addressgetinformationhash-filteroptions)
26+
- [address.getMetadata](api.md?id=addressgetmetadatahash-filteroptions)
27+
- [address.getAdoption](api.md?id=addressgetadoptionhash-filteroptions)
28+
- [address.getInternalMessages](api.md?id=addressgetinternalmessageshash-filteroptions)
29+
- [address.getFunctions](api.md?id=addressgetfunctionshash-filteroptions)
30+
- [address.getLogs](api.md?id=addressgetlogshash-filteroptions)
31+
- [address.getTransactions](api.md?id=addressgettransactionshash-filteroptions)
32+
- [address.getPendingTransactions](api.md?id=addressgetpendingtransactionshash-filteroptions)
33+
- [address.getBalance](api.md?id=addressgetbalancehash-filteroptions)
34+
- [address.getTokens](api.md?id=addressgettokenshash-filteroptions)
35+
- [address.getTokenTransfers](api.md?id=addressgettokentransfershash-filteroptions)
36+
- [address.getTokenBalances](api.md?id=addressgettokenbalanceshash-filteroptions)
37+
- [address.getUsage](api.md?id=addressgetusagehash-filteroptions)
38+
- [address.getMetrics](api.md?id=addressgetmetrics)
39+
- Block
40+
- [block.getBlocks](api.md?id=getblockid-filteroptions)
41+
- [block.getBlock](api.md?id=getblockid-filteroptions)
42+
- [block.getBlockNumber](api.md?id=)
43+
- [block.getBlockTransactionCount](api.md?id=)
44+
- [block.getTransactions](api.md?id=)
45+
- [block.getTransactionFromBlock](api.md?id=)
46+
- [block.getUncle](api.md?id=)
47+
- [block.getTokenTransfers](api.md?id=)
48+
- [block.getLogs](api.md?id=)
49+
- [block.getFunctions](api.md?id=)
50+
- [block.getMetrics](api.md?id=)
51+
- Blockchain
52+
- [blockchain.getMetrics](api.md?id=getmetricsfilteroptions)
53+
- Contract
54+
- [contract.getDetails](api.md?id=contractgetdetailshash)
55+
- [contract.getFunctions](api.md?id=contractgetfunctionshash)
56+
- [contract.getAbi](api.md?id=contractgetabihash)
57+
- [contract.getSourceCode](api.md?id=contractgetsourcecodehash)
58+
- Signature
59+
- [signature.getSignature](api.md?id=signaturegetsignaturehash)
60+
- Tokens
61+
- [token.getRankings](api.md?id=tokengetrankingsfilteroptions)
62+
- [token.getVolume](api.md?id=tokengetvolumehash-filteroptions)
63+
- [token.getVelocity](api.md?id=tokengetvelocityhash-filteroptions)
64+
- [token.getHolders](api.md?id=tokengetholdershash-filteroptions)
65+
- [token.getHoldersHistorical](api.md?id=tokengetholdershistoricalhash-filteroptions)
66+
- [token.getSupplies](api.md?id=tokengetsupplieshash-filteroptions)
67+
- [token.getTransfers](api.md?id=tokengettransfershash-filteroptions)
68+
- Transactions
69+
- [transaction.getTransactions](api.md?id=transactiongettransactionsfilteroptions)
70+
- [transaction.getAll](api.md?id=transactiongetallfilteroptions)
71+
- [transaction.getTransaction](api.md?id=transactiongettransactionhash-filteroptions)
72+
- [transaction.getPendingTransactions](api.md?id=transactiongetpendingtransactions)
73+
- [transaction.getGasPrediction](api.md?id=transactiongetgasprediction)
74+
- [transaction.getGasPercentiles](api.md?id=transactiongetgaspercentilesfilteroptions)
75+
- [transaction.getGasPrice](api.md?id=transactiongetgasprice)
76+
- [transaction.getVolume](api.md?id=transactiongetvolumefilteroptions)
77+
- [transaction.getMetrics](api.md?id=transactiongetmetricsfilteroptions)

0 commit comments

Comments
 (0)