Skip to content

Commit

Permalink
Update API_DOCUMENTATION_EN.md
Browse files Browse the repository at this point in the history
  • Loading branch information
linuxion authored Nov 26, 2018
1 parent feaff3c commit 926da74
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions API_DOCUMENTATION_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
+ [Address (Ethereum)](#ethereumdashboardsaddressa)
+ [Stats](#bitcoin-cashlitecoinethereumstats)
+ [General stats](#stats)
+ [Network stats](#bitcoin-cashlitecoinnodes)
+ [API request example](#api-request-examples)
+ [Broadcasting transactions](#broadcasting-transactions)
+ [Retrieving raw transactions](#retrieving-raw-transactions)
Expand Down Expand Up @@ -653,6 +654,18 @@ Returns data on four calls:
* `ethereum/stats`
* `litecoin/stats`

#### (bitcoin[-cash]|litecoin)/nodes

Returns data on networks stats.
* `nodes` - nodes
* `version` - user agent
* `country` - country (we use GeoIP)
* `height` - node's best height
* `flags` - [services](https://en.bitcoin.it/wiki/Protocol_documentation#version) flags
* `count` - nodes count
* `countries` - nodes count by country
* `versions` - nodes count by user agent

### API request examples

Suppose we would like to receive all the latest transactions from the Ethereum blockchain which amount to more than $1M USD. The following request should be done for this:
Expand All @@ -670,7 +683,7 @@ Increase offset value until getting a data set with the transaction that we alre

### Broadcasting transactions

In order to broadcast a transaction into the network, you should make a POST request to `https://api.blockchair.com/{chain}/push/transaction` (where `{chain}` can be one of those: `bitcoin`, `bitcoin-cash`, `ethereum`, and `litecoin`) with `data` holding hex represenatation of a transaction (for Ethereum it should start with `0x`). An example:
In order to broadcast a transaction into the network, you should make a POST request to `https://api.blockchair.com/{chain}/push/transaction` (where `{chain}` can be one of those: `bitcoin`, `bitcoin-cash`, `ethereum`, or `litecoin`) with `data` holding hex represenatation of a transaction (for Ethereum it should start with `0x`). An example:

```
curl -v --data "data=01000000010000000000000000000000000000000000000000000000000000000000000000ffffffff0704ffff001d0104ffffffff0100f2052a0100000043410496b538e853519c726a2c91e61ec11600ae1390813a627c66fb8be7947be63c52da7589379515d4e0a604f8141781e62294721166bf621e73a82cbf2342c858eeac00000000" https://api.blockchair.com/bitcoin/push/transaction
Expand All @@ -686,11 +699,11 @@ Example of a successful response:

### Retrieving raw transactions

It's possible to get raw transaction data directly from our nodes. In order to do this you should make the following API call: `https://api.blockchair.com/{chain}/raw/transaction/{txhash}` (where `{chain}` can be one of those: `bitcoin`, `bitcoin-cash`, `ethereum`, and `litecoin`)
It's possible to get raw transaction data directly from our nodes. In order to do this you should make the following API call: `https://api.blockchair.com/{chain}/raw/transaction/{txhash}` (where `{chain}` can be one of those: `bitcoin`, `bitcoin-cash`, `ethereum`, or `litecoin`)

The response contains two keys which are:
* `raw_transaction` - raw transaction represented as hex string
* `decoded_raw_transaction` (not available for Ethereum) - raw transaction encoded in JSON by our nodes. Please not that the structure of this JSON array may change as we upgrade our nodes, and this won't be reflected in our change logs.
* `decoded_raw_transaction` (not available for Ethereum) - raw transaction encoded in JSON by our nodes. Please note that the structure of this JSON array may change as we upgrade our nodes, and this won't be reflected in our change logs.

### Support

Expand Down

1 comment on commit 926da74

@nadinesuks
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do u do am I doing this block stuff correctly

Please sign in to comment.