Skip to content

Commit

Permalink
documentatin updates
Browse files Browse the repository at this point in the history
  • Loading branch information
divyasshree-BQ committed Mar 6, 2024
1 parent ed7dc35 commit b11b167
Show file tree
Hide file tree
Showing 7 changed files with 60 additions and 40 deletions.
2 changes: 1 addition & 1 deletion docs/graphql-ide/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "GraphQL IDE",
"label": "Quick Start",
"position": 2,
"link": {
"type": "generated-index",
Expand Down
2 changes: 1 addition & 1 deletion docs/graphql-ide/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 6
---

# Account
# Your Account Dashboard

Account dashboard gives you details related to your account like your subscriptions plan, API usage, frequently used queries etc. Let's epxlore each section on the page.

Expand Down
4 changes: 2 additions & 2 deletions docs/graphql-ide/apikey.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 2
---

# API Key
# Getting the API Key

The API Key is a string that we provide so that you can authenticate yourself to Bitquery services, both in the IDE and in your applications the same API Key is used. In order to get your API Key you must go here [User API Key](https://graphql.bitquery.io/user/api_key), there you can see all the API Keys you have created, you can also re-generate your API Key by clicking the `Regenerate API-KEY` button.

Expand All @@ -15,7 +15,7 @@ When regenerating an API Key it may take 5-10 minutes for your old API Key to be

To make use of the API Key will depend on your application, usually this is passed through the `X-API-KEY` header.

## Why
## Why do we need it

The use of the API Key is strictly related to the use of the account, this will allow you to register the points you have consumed, and the metrics associated to your account.

Expand Down
2 changes: 1 addition & 1 deletion docs/graphql-ide/errors.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Interpreting Errors
# Common Errors and What to Do

This section will guide you through the interpretation of common error messages encountered within Bitquery APIs. It will help you decide when to escalate issues by filing a ticket at [Bitquery Support](https://support.bitquery.io/).

Expand Down
86 changes: 53 additions & 33 deletions docs/graphql-ide/how-to-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,54 @@
sidebar_position: 1
---

# How to Start
# Running your First Query

The simplest way to create and run a query is to use the IDE: https://ide.bitquery.io/. You first have to register, and the IDE window will open.
Create and run your first query on Bitquery IDE by visiting [https://graphql.bitquery.io/ide](https://graphql.bitquery.io/ide).

## Get your API Key
## Create an account

To get your API key, use our IDE,
To continue, you must first [register](/docs/ide/login) an account to access the IDE window.

![graphql schema](/img/api-key.png)
**Registration Process**:

- Navigate to the Bitquery GraphQL IDE by visiting [https://graphql.bitquery.io/ide](https://graphql.bitquery.io/ide).
- If you are not registered, click on the "Not registered" link.
- You will need to provide your Email, Password, Password Confirmation, Name, and Company Name in the designated fields.
- Complete the CAPTCHA challenge and click the Submit button to proceed.
- After submitting your registration form, check your email for a confirmation message. Click the link within this email to verify your account. Once your email is successfully verified, you will receive a notification, confirming your account creation is complete.

## Important Links
If you do everything correctly, you will see the grey triangle in the middle of the screen to run the query.

- **V1 docs** - [`https://docs.bitquery.io/v1/`](https://docs.bitquery.io/v1/)
- **V2 Docs** - [`https://docs.bitquery.io/`](https://docs.bitquery.io/)
- [**Difference between v1 and v2**](v1-and-v2.md)
- How to call Bitquery APIs programmatically, [Read Here](https://bitquery.io/blog/graphql-with-python-javascript-and-ruby) and [here](https://community.bitquery.io/t/make-api-calls-to-bitquery-in-python-javascript-dart-golang-and-php/1004).
- To see the difference APIs provided by Bitquery please check [this](https://docs.google.com/presentation/d/1NET2jWidPNwuzR0_gy3SBY6_gX1n_a9KIHw4EQohDCE/edit?usp=sharing)
The query editor is in the center of the screen, and you can use handy Ctrl-Space key
combination to see all possible options that you can enter at the edit point.

[![Get started with Bitquery](/img/get-started-with-bitquery.jpeg)](https://www.youtube.com/watch?v=pOFVc-kgSxc "Get started with Bitquery - Click to Watch!")
![](/img/ide/quick_start.png)

So you can type the query using hints from IDE. For example, you can query the latest 10 blocks on the ETH network:

```
{
ethereum(network: ethereum) {
blocks(options: {limit: 10, desc: "timestamp.time"}) {
timestamp {
time
}
height
}
}
}
```

## Using Bitquery Explorer to get Queries

We have built our multi [blockchain explorer](http://explorer.bitquery.io/) to showcase our APIs, Therefore for beginners, I recommend first check our explorer.

You can enter your token, transaction, address anything and search for it. Once you see the relevant data you can click on the "graphql" button at the bottom right corner to check what GrpahQL query is responsible for that data. I highly recommend searching our explorer first before

You can enter your token, transaction, address anything and search for it. Once you see the relevant data you can click on the "graphql" button at the bottom right corner to check what GrpahQL query is responsible for that data. I highly recommend searching our explorer first before

[![Bitquey Explorer](/img/explorer.jpeg)](https://vimeo.com/548729514 "Bitquery Explorer - Click to Watch!")


## Check our IDE Explorer - Examples

We have built our [GraphQL IDE](https://graphql.bitquery.io/ide) to make it easy to work with blockchain data. Using our IDE you can create, save, test, and share your GraphQL queries.
Expand All @@ -45,39 +60,44 @@ You can find a lot of query examples created by our community on our IDE, I reco

![Queries Created and shared by Bitquery community|690x318](/img/queries-created-and-shared-by-Bitquery-community.png)

## Auto Complete

## Query Builder

We also have a Query Builder on our [IDE](https://graphql.bitquery.io/ide) which is built to help you create our queries easily. This way you can create queries with simple clicks.

[![Graphql API Builder](/img/graphql-api-builder.jpeg)](https://vimeo.com/521756813 "Graphql API Builder - Click to Watch!")
Use CTRL + Space to use autocomplete.

![query2](/img/ide/second.png)

**Check our Blog**
We have written a lot of blog posts to help you explain our APIs, please them on the [Bitquery blog](https://bitquery.io/blog). Additionally, read these blogs if you are new to Bitquery.
**Schema**

- [Make API calls to Bitquery in Python, JavaScript, Dart, Golang and PHP](https://community.bitquery.io/t/make-api-calls-to-bitquery-in-python-javascript-dart-golang-and-php/1004)
You can find our GraphQL Schema on our [IDE](https://graphql.bitquery.io/ide).

- [How to use GraphQL with Python, Javascript, and Ruby](https://bitquery.io/blog/graphql-with-python-javascript-and-ruby)
- [Create your first Blockchain GraphQL query](https://bitquery.io/blog/blockchain-graphql-query)
**Calling Bitquery APIs programmatically**
To call our APIs programmatically, you will need API keys, which you can get it by signing up on our [GraphQL IDE](https://graphql.bitquery.io/ide), to learn more read [this](https://bitquery.io/blog/graphql-with-python-javascript-and-ruby) article.

## Query Builder

## Auto Complete
We also have a Query Builder on our [IDE](https://graphql.bitquery.io/ide) which is built to help you create our queries easily. This way you can create queries with simple clicks.

Use CTRL + Space to use autocomplete.
[![Graphql API Builder](/img/graphql-api-builder.jpeg)](https://vimeo.com/521756813 "Graphql API Builder - Click to Watch!")

![query2](/img/ide/second.png)
## Important Links

**Schema**
- **V1 docs** - [`https://docs.bitquery.io/v1/`](https://docs.bitquery.io/v1/)
- **V2 Docs** - [`https://docs.bitquery.io/`](https://docs.bitquery.io/)
- [**Difference between v1 and v2**](v1-and-v2.md)
- How to call Bitquery APIs programmatically, [Read Here](https://bitquery.io/blog/graphql-with-python-javascript-and-ruby) and [here](https://community.bitquery.io/t/make-api-calls-to-bitquery-in-python-javascript-dart-golang-and-php/1004).
- To see the difference APIs provided by Bitquery please check [this](https://docs.google.com/presentation/d/1NET2jWidPNwuzR0_gy3SBY6_gX1n_a9KIHw4EQohDCE/edit?usp=sharing)

You can find our GraphQL Schema on our [IDE](https://graphql.bitquery.io/ide).
[![Get started with Bitquery](/img/get-started-with-bitquery.jpeg)](https://www.youtube.com/watch?v=pOFVc-kgSxc "Get started with Bitquery - Click to Watch!")

**Check our Blog**
We have written a lot of blog posts to help you explain our APIs, please them on the [Bitquery blog](https://bitquery.io/blog). Additionally, read these blogs if you are new to Bitquery.

**Calling Bitquery APIs programmatically**
To call our APIs programmatically, you will need API keys, which you can get it by signing up on our [GraphQL IDE](https://graphql.bitquery.io/ide), to learn more read [this](https://bitquery.io/blog/graphql-with-python-javascript-and-ruby) article.
- [Make API calls to Bitquery in Python, JavaScript, Dart, Golang and PHP](https://community.bitquery.io/t/make-api-calls-to-bitquery-in-python-javascript-dart-golang-and-php/1004)

- [How to use GraphQL with Python, Javascript, and Ruby](https://bitquery.io/blog/graphql-with-python-javascript-and-ruby)
- [Create your first Blockchain GraphQL query](https://bitquery.io/blog/blockchain-graphql-query)

**Community**
If you still don't question our GraphQL APIs please ask them on this forum, and always provide complete details.

Check our [Youtube Channel](https://www.youtube.com/@bitquery) for video tutorials.
Check our [Youtube Channel](https://www.youtube.com/@bitquery) for video tutorials.
2 changes: 1 addition & 1 deletion docs/graphql-ide/ide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 2
---

# IDE
# How to use the IDE ?

## What is Bitquery IDE?

Expand Down
2 changes: 1 addition & 1 deletion docs/graphql-ide/points.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 4
---

# Points
# What are Points?

At Bitquery we use points system to calculate the cost for a query. Each query will use different number of points, based on the complexity and size of the query requested. For a comprehensive understanding of the points system, please refer to [our detailed post](https://community.bitquery.io/t/introducing-points/874).

Expand Down

0 comments on commit b11b167

Please sign in to comment.