Send Airdrop

Distribute tokens to multiple addresses simultaneously through an airdrop. This endpoint allows you to send different amounts to different recipients in a single transaction.

POSTapi.metal.build/token/:address/airdrop

Send airdrop

This endpoint initiates a token airdrop to multiple recipients.

Required attributes

  • Name
    sendTo
    Type
    array
    Description

    Array of recipient objects, each containing:

    {
      "holder": "string",
      "amount": "number"
    }
    

Request

POST
api.metal.build/token/:address/airdrop
curl https://api.metal.build/token/0x1234567890abcdef1234567890abcdef12345678/airdrop \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR-API-KEY" \
  -d '{
    "sendTo": [
      {
        "holder": "0xabcdef1234567890abcdef1234567890abcdef12",
        "amount": 100
      },
      {
        "holder": "0x7890abcdef1234567890abcdef1234567890abcd",
        "amount": 200
      },
      {
        "holder": "0x3456789012345678901234567890123456789012",
        "amount": 150
      }
    ]
  }'

Response

{
  "jobId": "e20b21ec-10ca-5756-938c-855e78add351",
  "status": "pending"
}

GETapi.metal.build/token/:address/airdrop/status/:jobId

Status

This endpoint will return the status of your airdrop distribution.

Required attributes

  • Name
    jobId
    Type
    string
    Description

    Job ID of the airdrop distribution.

Request

GET
api.metal.build/token/:address/airdrop/status/:jobId
curl https://api.metal.build/token/0x1234567890abcdef1234567890abcdef12345678/airdrop/status/e20b21ec-10ca-5756-938c-855e78add351 \
  -H "x-api-key: YOUR-API-KEY"

Pending Response

{
  "jobId": "e20b21ec-10ca-5756-938c-855e78add351",
  "status": "pending"
}

Successful Response

{
  "jobId": "e20b21ec-10ca-5756-938c-855e78add351",
  "status": "success"
}

Was this page helpful?