# Bloq Connect Overview

The Bloq Connect service provides real-time blockchain and indexed data.

Currently, the Connect service supports the following chains:

  • Bitcoin (BTC) Mainnet
  • Bitcoin Cash (BCH) Mainnet
  • Ethereum (ETH) Mainnet
  • Ethereum Ropsten Testnet
  • Ethereum Rinkeby Testnet
  • Ethereum Goerli Testnet
  • Ethereum Kovan Testnet
  • Ethereum Classic (ETC) Mainnet
  • Ethereum Classic Mordor Testnet
  • Ethereum Classic Kotti Testnet

The current version of the Bloq Connect API is 1.0.

TIP

An active Connect plan is required for users to interact with the Connect API. Users can start and manage their plan through the Bloq Console Connect webpage.

# Interfaces

# Bitcoin and Bitcoin Cash

# HTTP REST

The HTTP REST interface enables users to use HTTP requests to GET and POST data.

# WebSocket

The WebSocket interface (using socket.io) enables users to subscribe to events without the need to continually poll the HTTP REST API.

# Rate Limits

We employ a rate limit across our blockchain services to prevent denial-of-service attacks. If you are running a service that requires service higher than our standard rate limit, please contact Bloq support to request an increase.

# Ethereum and Ethereum Classic

The HTTP JSON RPC interface provides an interface compatible with the standard Ethereum JSON RPC API.

# API URLs

The following URLs are provided for the Connect service:

Protocol Chain URL
Bitcoin (BTC) Mainnet https://btc.connect.bloq.cloud/api/v1
Bitcoin Cash (BCH) Mainnet https://bch.connect.bloq.cloud/api/v1
Ethereum (ETH) Mainnet https://eth.connect.bloq.cloud/v1/<project-id>
Ethereum Ropsten Testnet https://ropsten.connect.bloq.cloud/v1/<project-id>
Ethereum Rinkeby Testnet https://rinkeby.connect.bloq.cloud/v1/<project-id>
Ethereum Goerli Testnet https://goerli.connect.bloq.cloud/v1/<project-id>
Ethereum Kovan Testnet https://kovan.connect.bloq.cloud/v1/<project-id>
Ethereum Classic (ETC) Mainnet https://etc.connect.bloq.cloud/v1/<project-id>
Ethereum Classic Mordor Testnet https://mordor.connect.bloq.cloud/v1/<project-id>
Ethereum Classic Kotti Testnet https://kotti.connect.bloq.cloud/v1/<project-id>

# BTC and BCH Connect

The interface is based on Bitcore's Insight API and are compatible with existing applications that rely on existing Insight-compatible APIs.

# Authentication

The API requires authentication for all its endpoints. To authorize the request, a client access token must be sent in the Authorization header.

Example:

curl \
  -X GET \
  -H "Authorization: Bearer xxxxxx.xxxxxxxxxx.xxxxxx" \
  https://btc.connect.bloq.cloud/api/v1/status

# CLI

The CLI has some limited Connect functionality under the connect command. In most cases you will be using Connect through the JavaScript SDK or the REST API.

Remember that before using any Bloq service, you have to create a valid pair of client keys.

For example if you want to retrieve a block you can run connect block command:

$ bcl connect block -a 00000000000000000018339a7b3cb0fa1545aa399eedf34827c85d8aadb8d196

{
  "hash": "00000000000000000018339a7b3cb0fa1545aa399eedf34827c85d8aadb8d196",
  "confirmations": 1,
  "size": 910763,
  "height": 568126,
  "version": 536870912,
  "merkleroot": "2b475e078ac49296923970c5f7098c8db78216d6d419af69fc1dfbd35816ebab",
  "time": 1553176176,
  "nonce": 351800022,
  "bits": "172e6117",
  "difficulty": 6068891541676.553,
  "chainwork": "000000000000000000000000000000000000000005842654fa8d8a928107e5f2",
  "previousblockhash": "00000000000000000010ee29bd09dc3395f1a793f7c7e76a16a7a9081509b50b",
  "poolInfo": {},
  "reward": 12.5,
  "isMainChain": true,
  "tx": [ ... ]
}

These are the connect methods supported by CLI: block,blocks,block-hash,raw-block,transaction,tx,raw-transaction and raw-tx.

# ETH and ETC Connect

The interface is based on Ethereum's JSON RPC.

# Project identification

The API requires a valid project ID to allow users send JSON RPC requests.

Example:

curl \
  -X POST \
  -H "Content-Type: application/json" \
  -d "{\"jsonrpc\":\"2.0\",\"method\":\"eth_blockNumber\",\"params\":[],\"id\":1}" \
  https://eth.connect.bloq.cloud/v1/my-project-id

Project IDs can be created through the Bloq Console website.

# Supported methods

Last updated: 7/30/2020, 4:42:31 AM