Airdrop_Server_Endpoints

Airdrop Server Endpoints

Last Modified: 2024-04-27
Author: Phill Weston

REST API Endpoints for Airdrop Server

GET /v1/info/apply_airdrop Only enabled when ApiMode=0
- Description: Retrieves the transaction count for a given address. If the transaction count meets the specified conditions, the airdrop will be issued to this address as planned.
- Parameters:
  - address (String): The blockchain address to query.
- Response:
  - address: Wallet address of the current user, should be the same as the input address.
  - transaction_count (Integer): The number of transactions associated with the address.
  - airdrop_count (Integer): The airdrop count for the address.
  - has_airdropped_count (Boolean): The number of airdrops that have been issued to this address.
  - scheduled_delivery (String): The next available time for airdropping.
- Example:
  
  Request:
```
curl --location 'http://127.0.0.1:1423/v1/info/apply_airdrop?address=0x0000000000000000000000000000000000000001'
```
  Response:
```
{
  "code": 0,
  "message": "Success",
  "error": "",
  "data": {
     "address": "0x0000000000000000000000000000000000000001",
     "transaction_count": 11,
     "airdrop_count": 100000,
     "has_airdropped_count": 0,
     "scheduled_delivery": "2024-04-01T08:00:00Z"
  }
}
```
POST /v1/info/set_airdrop Only enabled when ApiMode=1
- Description: Issue a specified number of airdrops to a specified address. Each address can only be specified once.
- Parameters:
  - address (String): The blockchain address which airdropped to.
  - amount (Integer): The amount of airdrops to be distributed, should <= 100000000.
- Response:
  - address: Wallet address of the current user, should be the same as the input address.
  - transaction_count (Integer): The number of transactions associated with the address.
  - airdrop_count (Integer): The airdrop count for the address.
  - has_airdropped_count (Boolean): The number of airdrops that have been issued to this address.
  - scheduled_delivery (String): The next available time for airdropping.
- Example:
  
  Request:
```
curl --location 'http://127.0.0.1:1423/v1/info/set_airdrop' \
--header 'Content-Type: application/json' \
--data '{
    "address":"0x0000000000000000000000000000000000000001",
    "amount": 10000
}'
```
  Response:
```
{
  "code": 0,
  "message": "Success",
  "error": "",
  "data": {
     "address": "0x0000000000000000000000000000000000000001",
     "transaction_count": 0,
     "airdrop_count": 10000,
     "has_airdropped_count": 0,
     "scheduled_delivery": "2024-04-01T08:00:00Z"
  }
}
```
POST /v1/info/append_airdrop Only enabled when ApiMode=1
- Description: Additional airdrops of the specified number will be issued to the specified address. The address to be appended the airdrop must first be set_airdrop called. Each address can be appended multiple times.
- Parameters:
  - address (String): The blockchain address which will be appended airdrop to.
  - amount (Integer): The amount of airdrops to be appended, should <= 100000000.
- Response:
  - address: Wallet address of the current user, should be the same as the input address.
  - transaction_count (Integer): The number of transactions associated with the address.
  - airdrop_count (Integer): The airdrop count for the address.
  - has_airdropped_count (Boolean): The number of airdrops that have been issued to this address.
  - scheduled_delivery (String): The next available time for airdropping.
- Example:
  
  Request:
```
curl --location 'http://127.0.0.1:1423/v1/info/set_airdrop' \
--header 'Content-Type: application/json' \
--data '{
    "address":"0x0000000000000000000000000000000000000001",
    "amount": 100
}'
```
  Response:
```
{
  "code": 0,
  "message": "Success",
  "error": "",
  "data": {
     "address": "0x0000000000000000000000000000000000000001",
     "transaction_count": 0,
     "airdrop_count": 10100,
     "has_airdropped_count": 10000,
     "scheduled_delivery": "2024-04-01T08:00:00Z"
  }
}
```
GET /v1/info/check_eligibility Only enabled when ApiMode=1
- Description: Retrieves whether the specified address purchased the first Lotso Token before the attack.
- Parameters:
  - address (String): The blockchain address that will be checked.
- Response:
  - data (Boolean): Whether the specified address purchased the first Lotso Token before the attack.
- Example:
  
  Request:
```
curl --location 'http://127.0.0.1:1423/v1/info/check_eligibility?address=0x0000000000000000000000000000000000000001'
```
  Response:
```
{
  "code": 0,
  "message": "Success",
  "error": "",
  "data": true
}
```

GET /v1/info/recipient_info Only enabled when Debug=true

Description: Retrieves the recipient count for the airdrop.
Response:
- data (Integer): The number of recipients eligible for the airdrop.

Example:

Request:

curl --location 'http://127.0.0.1:1423/v1/info/recipient_info'

Response:

{
  "code": 0,
  "message": "Success",
  "error": "",
  "data": {
   "recipient_count": 1,
   "airdrop_amount": 100000,
  }
}

GET /v1/info/addresses_should_airdrop Only enabled when Debug=true
- Description: Retrieve the address and quantity of the next airdrop. The amount of the next airdrop is airdrop_count minus has_airdropped_count.
- Response:
  - data (List): The number of recipients who have manually claimed the airdrop.
- Example:
  
  Request:
```
curl --location 'http://127.0.0.1:1423/v1/info/recipient_info'
```
  Response:
```
{
  "code": 0,
  "message": "Success",
  "error": "",
  "data": 1
}
```

GET /v1/info/distribute_airdrops Only enabled when Debug=true

Description: Distribute airdrops.
Response:
- data (List): The transaction hashes of distributing airdrops.

Example:

Request:

curl --location --request POST 'http://127.0.0.1:1423/v1/info/distribute_airdrops'

Response:

{
  "code": 0,
  "message": "Success",
  "error": "",
  "data": [
    "0x58fad0f6535a3beda4dd8c1c39d1fe350c7d9518e55999e5ab11f40c4129fdb1"
  ]
}

GET /v1/info/distribute_airdrops_to *Only enabled when Debug=true
- Description: Distribute a specified number of airdrops to a specified address.
- Parameters:
  - address (String): The blockchain address which will be distributed airdrop to
  - amount (Integer): The amount of airdrops to be distributed.
- Response:
  - data (String): The transaction hash of distributing airdrops.
- Example:
  
  Request:
```
curl --location 'http://127.0.0.1:1423/v1/info/distribute_airdrops_to' \
--header 'Content-Type: application/json' \
--data '{
    "address":"0x0000000000000000000000000000000000000001",
    "amount": 1000000
}'
```
  Response:
```
{
  "code": 0,
  "message": "Success",
  "error": "",
  "data": "0x58fad0f6535a3beda4dd8c1c39d1fe350c7d9518e55999e5ab11f40c4129fdb1"
}
```

GET /v1/info/claim_airdrop *Only enabled when Debug=true

Description: Receive airdrops as a designated account
Parameters:
- private_key (String): The blockchain address which will be distributed airdrop to.
Response:
data (String): The transaction hash of distributing airdrops.

Example:

Request:

curl --location 'http://127.0.0.1:1423/v1/info/claim_airdrop' \
--header 'Content-Type: application/json' \
--data '{
    "private_key":"0x0000000000000000000000000000000000000000000000000000000000000001"
}'

Response:

{
  "code": 0,
  "message": "Success",
  "error": "",
  "data": "0x58fad0f6535a3beda4dd8c1c39d1fe350c7d9518e55999e5ab11f40c4129fdb1"
}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Airdrop_Server_Endpoints

Airdrop Server Endpoints

REST API Endpoints for Airdrop Server

Clone this wiki locally