Offchain Integration

DappLooker allows developers to register and showcase their OffChain projects, which are applications that interact with the blockchain but do not store their data directly on the blockchain. DappLooker supports two formats: JSON API and CSV, to facilitate the registration process. Below, you will find instructions for each format.
JSON API
The JSON API format allows you to register your OffChain projects on DappLooker programmatically using the JSON data structure. Follow the steps below to register your project:
1.Authentication: Before making API calls, you need to authenticate with DappLooker. Obtain an API key by signing up on the DappLooker website and navigating your account settings. The API key will be required to include in the headers of your API requests.
2.Endpoint: Make a POST request to the following endpoint to register your OffChain project:
POST https://api.dapplooker.com/offchain/projects
3.Request Payload: The request payload should be a JSON object containing the details of your OffChain project. Here's an example of the required fields:
{
  "name": "My OffChain Project",
  "description": "A brief description of my OffChain project",
  "website": "https://myproject.com",
  "github": "https://github.com/myproject",
  "blockchain": "Ethereum",
  "tags": ["dapp", "offchain"],
  "contacts": ["[email protected]", "[email protected]"]
}
Customize the fields according to your project's details. Ensure that the name the field is unique and represents the name of your OffChain project.
4.Headers: Include the following headers in your API request:
Content-Type: application/json
Authorization: Bearer <your_api_key>
Replace <your_api_key> with the API key obtained during authentication. The Content-Type header specifies that the payload is in JSON format, and the Authorization header authorizes your request with DappLooker.
5.Response: Upon successful registration, the API will respond with a 200 OK status code and a JSON object containing the registered project's details. Make sure to handle any errors returned by the API and handle them accordingly.
{
  "id": "123456",
  "name": "My OffChain Project",
  "description": "A brief description of my OffChain project",
  "website": "https://myproject.com",
  "github": "https://github.com/myproject",
  "blockchain": "Ethereum",
  "tags": ["dapp", "offchain"],
  "contacts": ["[email protected]", "[email protected]"]
}
Note the id field, which represents the unique identifier assigned to your project by DappLooker. You may need this ID for future interactions with the DappLooker API.
CSV
DappLooker also supports registering OffChain projects using a CSV file. Follow the steps below to register your project using this format:
1.Authentication: Just like in the JSON API format, ensure that you have obtained your API key from DappLooker.
2.CSV Format: Create a CSV file with the following headers as the first row:
name,description,website,github,blockchain,tags,contacts
Each subsequent row should contain the corresponding values for each header. Here's an example:
My OffChain Project,A brief description of my OffChain project,https://myproject.com,https://github.com/myproject,Ethereum,"dapp,offchain",[email protected];[email protected]
Make sure to replace the values with your project's details. The tags field can include multiple tags separated by commas.
3.Endpoint: Make a POST request to the following endpoint to upload the CSV file:
POST https://api.dapplooker.com/offchain/projects/csv
4.Headers: Include the following headers in your API request:
Content-Type: text/csv
Authorization: Bearer <your_api_key>
The Content-Type header specifies that the payload is in CSV format, and the Authorization header authorizes your request with DappLooker.
5.Response: Upon successful registration, the API will respond with a 200 OK status code and a JSON object containing the registered project's details, similar to the JSON API response.
​
Subquery
Analytics
Last modified 2mo ago