API Service

Supported Networks

• Polkadot

• Kusama

• Westend

• Base

• Optimism

• Ethereum

• Gargantua

Get an API Key

To get started, visit https://beta-app.blockops.network and navigate to the API Service page. You can either register for a new account or log in if you already have one.

After your account has been verified, navigate to the API service dashboard, which allows you to create projects which generate your API keys.

Projects serve as a centralized location within your workspace where you can manage your API key and view analytics. They essentially act as containers that hold these components together.

Click Connect to connect to any of the available networks on Blockops. Select the network you want to connect, and enter your project’s name.

Finally click Connect button you’ll be taken to a page where you can view your API Service projects.

Authentication with API Key

Once you created a project, an API key will automatically be generated for you. Click on that project to view the network endpoint and the API key – a token required for the interaction with the service and making API requests.

Send requests

Connect via Command Line

You can connect to the network using websocket or HTTP with your API key in two ways:

• Adding the API key as a query string ?api_key=${APIKEY}

• Or the request header -H 'authorization: APIKEY ${APIKEY}'

Curl

For example, the following CURL command can be used to get header and body of a relay chain block.

curl -H "Content-Type: application/json" -H 'authorization: APIKEY xxxx'  -d '{"id":1, "jsonrpc":"2.0", "method": "chain_getBlock"}' https://polkadot-rpc.blockops.network/rpc

Here is the response you will receive back.

{"jsonrpc":"2.0","result":{"block":{"header":{"parentHash":"0x381dd358f0b1e328e861822b2a51a72e8dc064803a5c7ccc96277da3b16d7667","number":"0xe07a1d","stateRoot":"0xa2aacd7ef5d7ff66da1df6643b3e1c13975d210363c568f1bed51bad56cf40db","extrinsicsRoot":"0x00bc7f1504c9a07364835d80d2114ca3d4e7ad774453198b119bea9be2a1f7c1","digest":{"logs":["0x0642414245b50103d8000000d17aae1000000000768dc1931ba697bb9ab4a08debf5d710bd1f55e6325d65315161c2340cc0217170dfe2df24a3680c8ff48868ac665f4b34ebefa4bc844d510c848d9fc99252035db579a0acbf52cded336d6daf6ab7fdb1d1eee0d480e6388c2a12785d4de809"]},"justifications":null},"id":1}

Wscat

If you want to send data requests with WebSockets, you can use several libraries or wscat. You can install and use wscat as follows:

• Download wscat from https://www.npmjs.com/package/wscat

• Install wscat by running the following command: npm install -g wscat

You can connect to the network with wscat using two options by adding the API key as a query string.

wscat -c 'wss://polkadot-rpc.blockops.network/ws' --header 'authorization: APIKEY xxxx'

Or the request header.

wscat -c 'wss://polkadot-rpc.blockops.network/ws?api_key=**********************'

After executing the command, the terminal will display a message indicating that the connection has been enabled successfully.

Connected (press CTRL+C to quit)
>

Then, you can send the following request:

{"id":1, "jsonrpc":"2.0", "method": "chain_getBlock"}

Connect via Polkadot JS UI

To access our API service, you can use the Polkadot/Substrate Portal. First, go to the PolkadotJS UI and then open the Explorer tab located under Network. Finally, click on the Polkadot Icon located at the top of your screen.

This will open the Network switcher which will allow you to select the network that you connect to. You can add your Blockops API service endpoint to the Development section by pasting the websocket connection URL into the custom endpoint field and clicking on the save icon.

You're now connected and can start making calls with the Polkadot/Substrate UI App

Regenerate API Key

In case you suspect that an unauthorized third party is using your API key, you have the option to reset it by using the change Key button located in the project dashboard.

API Service Rate Limiting

The Blockops API service has a limit on the number of requests that can be made to each API endpoint. The limit depends on whether you are using the public rpc endpoint or an API key.

The number of requests you can make before reaching the limit or being rate-limited will vary based on your chosen method of access.

• Public API endpoint - 50 requests/second

• Private API endpoint - 1000 requests/second

Typically only aggressive use should experience rate limiting.

Customers running into rate limits are encouraged to contact us. We'll work with you to determine how best to avoid rate limits.

Error Codes

The following error codes are frequently returned by our API service. However, it's important to note that this list doesn't include errors related to network-specific business logic.

Track your projects

The project List shows all active projects, the network type, the creation date, and the status of the project. You also have the ability to search the projects by name.

Pricing and Costs