# README

![](https://847369752-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MkXMMUKnHh5eBC1WgyG%2F-MkfHV2WBl6RKXmUXNQG%2F-MkfJvBJSJsQ_pXQsJ6I%2FScreenshot%202021-09-06%20at%2019.35.54.png?alt=media\&token=ba86a579-042d-464d-bdf2-2da0be147ece)

[![BC-API version](https://camo.githubusercontent.com/0a2197d8059dd06f57fb5b41a36666d29dfcde709941cb2e802dd21e71f7b597/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f76657273696f6e2d76302e312e322d626c75653f7374796c653d666f722d7468652d6261646765266c6f676f3d6e6f6e65)](https://github.com/DiFronzo/blockchair/releases) [![go version](https://camo.githubusercontent.com/58e45131396897b5b6594051ba0314985cb5ef3eeefae1f80ee606b92d361d14/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f474f2d312e31372b2d3030414444383f7374796c653d666f722d7468652d6261646765266c6f676f3d474f)](https://golang.org/) [![license](https://camo.githubusercontent.com/4063c583e768bf475969c3d8701fe6962706b61cf525dc7b4f1850ed5c061a20/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d7265643f7374796c653d666f722d7468652d6261646765266c6f676f3d6e6f6e65)](https://camo.githubusercontent.com/4063c583e768bf475969c3d8701fe6962706b61cf525dc7b4f1850ed5c061a20/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d7265643f7374796c653d666f722d7468652d6261646765266c6f676f3d6e6f6e65) [![code size](https://camo.githubusercontent.com/418104517418f4ce5070df29069617d0bf2a0dd07fb4bea659a1df2e8738e0e0/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f636f64652d73697a652f646966726f6e7a6f2f626c6f636b63686169723f7374796c653d666f722d7468652d6261646765266c6f676f3d6e6f6e65)](https://camo.githubusercontent.com/418104517418f4ce5070df29069617d0bf2a0dd07fb4bea659a1df2e8738e0e0/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f636f64652d73697a652f646966726f6e7a6f2f626c6f636b63686169723f7374796c653d666f722d7468652d6261646765266c6f676f3d6e6f6e65) [![GO report](https://camo.githubusercontent.com/33f4225b5cf8cdc56dcb9faf2b2a940ad9ff30c944f70794b811e052957ad620/68747470733a2f2f676f7265706f7274636172642e636f6d2f62616467652f6769746875622e636f6d2f446946726f6e7a6f2f626c6f636b63686169723f7374796c653d666f722d7468652d6261646765266c6f676f3d6e6f6e65) ](https://goreportcard.com/report/github.com/DiFronzo/blockchair)[![GoDoc](https://camo.githubusercontent.com/3990b1a9948c6803a0ed1e8f45b6e399f0cbe1691b35acf0d7001854b7981219/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f476f446f632d7265666572656e63652d626c75653f7374796c653d666f722d7468652d6261646765266c6f676f3d676f)](https://pkg.go.dev/github.com/DiFronzo/blockchair) [![GitHub Workflow Status](https://camo.githubusercontent.com/8fb1da014565948d09f7ac52ad1a8f6606af1084aa9a224b2ae202f986eb3a9a/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f776f726b666c6f772f7374617475732f646966726f6e7a6f2f626c6f636b63686169722f54657374733f6c6f676f3d676974687562267374796c653d666f722d7468652d6261646765)](https://github.com/DiFronzo/blockchair/actions)<img src="https://847369752-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MkXMMUKnHh5eBC1WgyG%2F-MkfHV2WBl6RKXmUXNQG%2F-MkfHlpgKsTdeLQvM3qx%2FGITBOOK%20DOCUMENTATION.svg?alt=media&#x26;token=7422eb46-9528-46f5-babc-3dae233e4e5a" alt="" data-size="original">&#x20;

## ⚡️ Quick start

First of all, [download](https://golang.org/) and install **GO**. Version `1.17` or higher is required.

Verify that the installation was successful by running the following command that should return the version number for GO.

```
go version
```

{% hint style="success" %}
If this command work, Go is successfully installed!
{% endhint %}

To quickly start using the module run the following command for installation.

```
go install github.com/DiFronzo/blockchair@latest
```

{% hint style="info" %}
For a detailed usage instructions, please refer to Dashboard [documentation](https://blockchair.vfiles.no/dashboard).
{% endhint %}

That's all you need to know to start! 🎉

## ⚙️ Usage & Options

### **Dashboard:**

* [Transaction info](https://blockchair.vfiles.no/dashboard/transaction-info)
* [Block info](https://blockchair.vfiles.no/dashboard/block-info)
* [Address info](https://blockchair.vfiles.no/dashboard/address-info)

For an example of usage see [here](https://github.com/DiFronzo/blockchair/blob/main/example/main.go).

### 🐳 Docker-way to quick start

UNDER CONSTRUCTION.

## ⭐️ Project assistance

If you want to say **thank you** or/and support active development of `blockchair`:

* Add a [GitHub Star](https://github.com/DiFronzo/blockchair) to the project.

## ⚠️ License

`Blockchair` is free and open-source software licensed under the [MIT](https://github.com/DiFronzo/blockchair/blob/main/LICENSE). This is not an offical release from [Blockchair](https://github.com/Blockchair). Use on your own risk.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://blockchair.vfiles.no/master.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.