SoQuest API for Partners

SoQuest plays an important role in the achievement of Web3-native Gleam. SoQuest provides you with the opportunity to manage your community giveaways and keep track of all processes so you can engage with your tribe like never before.

With SoQuest, the NFT Mint process is not directly implemented for now. Therefore, SoQuest drives more Web3 automation scenarios by providing data to third-party platforms. SoQuest facilitates the automation of the NFT Mint process by providing the data sources directly to third-party NFT Mint platforms. The minting process is thus made indirectly.

We currently provide data to our partners in the following ways:

• Data Export

• API to read

Among them, the method of exporting data is offered so our partners can directly export the resulting data in the SoGraph Dashboard. The method of API reading is to produce real-time updates and read directly through the API.

This way we save a lot of exporting and docking work, and the users can mint the NFTs and receive their airdrop at hyper speed.

API Key

To obtain the results of the Campaign in a real-time way through API, it is necessary to generate its API Key in the Dashboard first (SoGraph Dashboard > Space Profile > Generate API Key).

The API Key is a random string character. Please keep it properly secured to avoid leakage. Once the API Key is leaked, other people can consume your usage through it, which will lead to the ban of API.

API interface

Currently, we provide two data interfaces for reading. When using the API, we just need to get the API URL as well as a valid API Key. Simply add the 'api-key' parameter in the URL and it can be used. The API URL is directly copied by the event organizers in the Dashboard. During interconnection, you only need to provide the part of the API Key to obtain the complete URL.

Candidate List API

The list of campaign candidates can be obtained through API. The access methods are as follows:

<https://api.sograph.xyz/api/campaign/{campaign_code}/candidates?api-key={YOUR_API_KEY}>

The returned data format is as follows:

{
  "code": 0, // Response Code, Non-zero for error code
  "data": {
    "campaign_code": "Lc1pQWXgis", // Campaign Code
    "campaign_name": "Port3 x SPACE ID: 100 .bnb Domain Name WL Giveaway", // Campaign Name
    "total": 1905, // Candidates Count
    "candidates": [ // Candidates Address, sort by entries decending
			// Address and Entires
      {"address": "0xF68AD20b1E922d278240898936343B7b89577ea3", "entries": 8},
      ...
      {"address": "0xc370cA54113784169687c89cC0115c0f1a75C4DD", "entries": 6}
    ]
  },
  "message": "OK"
}

Winner List API

The list of winners can be accessed through the API as follows:

<https://api.sograph.xyz/api/campaign/{campaign_code}/prize/{prize_code}/winners?api-key={YOUR_API_KEY}>

The returned data format is as follows:

{
  "code": 0, // Response Code, Non-zero for error code
  "data": {
    "campaign_code": "Lc1pQWXgis", // Campaign Code
    "campaign_name": "Port3 x SPACE ID: 100 .bnb Domain Name WL Giveaway", // Campaign Name
    "prize_code": "1659334071-1", // Prize Code
    "prize_name": “OG NFT”, // Prize Name
    "total": 80, // Prize Total
    "winners": [ // Winner Addresses
      "0x945a064b0132c8eBeCAe243528c7E43ED52e5FEb",
      "0x9BFF62c421478178A87Ae92e79133c99101D748F",
      ...
      "0x1C670dc214de4819730e7305703ec8C986B8C7fc"
    ]
  },
  "message": "OK"
}