Skip To Content

Blockdaemon Documentation

Swagger (Quick Start)

Overview
1. Generate a Ubiquity API Key on Blockdaemon App
2. Authorize a Request with Ubiquity
3. Send a Request with Ubiquity
4. Receive a Response


Overview

This guide allows you to quickly get started with Ubiquity.

Within this guide, we recommend using the Ubiquity Swagger API specification as the easiest way to get started. Alternative clients and methods of access are available: see quick start guides for other tools.


1. Generate a Ubiquity API Key on Blockdaemon App

To use the Ubiquity API, you need to get the API access key. This is a 47-character unique number.

To generate a Ubiquity API key, sign up to the Blockdaemon application and take the following steps:

  1. Navigate to the Ubiquity API section
  2. Click on Start using the Blockdaemon API
  3. In the pop-up window, enter your desired Key Name
  4. Click on the Create API Key button to generate the key
  5. Click on your key to copy it

Existing Blockdaemon API key holders:

  • Navigate to Ubiquity API > Configure
  • Click on Create New Key
  • Take steps 3–5 above

Check out Keke’s video guide on creating your Ubiquity API Key

Please note:

  • If you lose the key, you will not be able to retrieve it.
  • You should immediately store your key in a secure place.

2. Authorize a Request with Ubiquity

You need to authorize your request before sending:

  1. Go to Ubiquity Swagger API
  2. Scroll the page down to see Ubiquity endpoints
  3. Click on the Authorize button right above the endpoints
  4. In the pop-up window, paste your API key in the Value input box
  5. Click on Authorize
  6. Click on Close

authozing a Ubiquity request in Swagger

adding a Ubiquity API key as a bearer token in Swagger


3. Send a Request with Ubiquity

This example uses Ubiquity to get the current block number in Ethereum Mainnet:

  1. Scroll down to the Sync section
  2. Click on /v1/{protocol}/{network}/sync/block_number
  3. Select Ethereum in the platform drop-down menu
  4. Make sure that network is set to Mainnet
  5. Click on the Try it out button
  6. Click on the Execute button that appears below
  7. Click on Close

executing a Ubiquity query in Swagger


4. Receive a Response

The API response is displayed below the Execute button, in the Responses section:

getting a response from the Ubiquty API in Swagger

Please note that Swagger generates a cURL example and a request URL, which you can use with other tools:

cURL

curl -X GET "https://ubiquity.api.blockdaemon.com/v1/ethereum/mainnet/sync/block_number" -H  "accept: application/json" -H  "Authorization: Bearer YOUR_API_KEY"

Request URL

https://ubiquity.api.blockdaemon.com/v1/ethereum/mainnet/sync/block_number

The received output contains the current block number for Ethereum Mainnet:

15119682

Learn more about the endpoint: GET Current Block Number (V1)

We don't support Internet Explorer

Please use Chrome, Safari, Firefox, or Edge to view this site.