Indexer API.md

zkBring Indexer API

Get Drop

GET /drops/{drop_address}

Params

• drop_address: drop's contract address

Optional Query Parameter:

• fetch_as: user address fetching the data

Response:

{
  "drop_address": "string",          // Unique identifier/address of the drop
  "amount": "number",                // Amount associated with the drop
  "max_claims": "number",            // Maximum number of claims allowed
  "claims": "number",                // Number of claims that have occurred
  "creator_address": "string",       // Address of the creator
  "token_address": "string",         // Address/ID of the token
  "expiration_timestamp": "string",  // Expiration time (timestamp format)
  "status": "string",                // Current status of the drop
  "metadata_ipfs_hash": "string",    // IPFS hash for associated metadata
  "zk_pass_manifest_id": "string",   // Domain-specific identifier
  "fetcher_data": {                  // Optional, returned only if ?fetch_as is provided
    "account_address": "string",     // Address of the account making the request
    "claimed": "boolean",            // Whether the drop has been claimed
    "claim_tx_hash": "string"        // Transaction hash for the claim (if claimed)
  }
}

Get Drops

GET /drops

Optional Query Parameters:

• fetch_as: user address fetching the data
• creator_address: filter drops by drop creator address

Response:

[
  {
    "drop_address": "string",          // Unique identifier/address of the drop
    "amount": "number",                // Amount associated with the drop
    "max_claims": "number",            // Maximum number of claims allowed
    "claims": "number",                // Number of claims that have occurred
    "creator_address": "string",       // Address of the creator
    "token_address": "string",         // Address/ID of the token
    "expiration_timestamp": "string",  // Expiration time (timestamp format)
    "status": "string",                // Current status of the drop
    "metadata_ipfs_hash": "string",    // IPFS hash for associated metadata
    "zk_pass_manifest_id": "string",   // Domain-specific identifier
    "fetcher_data": {                  // Optional, returned only if ?fetch_as is provided
      "account_address": "string",     // Address of the account making the request
      "claimed": "boolean",            // Whether the drop has been claimed
      "claim_tx_hash": "string"        // Transaction hash for the claim (if claimed)
    }
  }, ...
]

Get Drop Claimer

GET /drops/{drop_address}/claimer/{claimer_address}

Optional Query Parameters:

• claimer_address: account address of the potential claimer

Response:

{
    "account_address": "string",     // Address of the account making the request
    "claimed": "boolean",            // Whether the drop has been claimed
    "claim_tx_hash": "string"        // Transaction hash for the claim (if claimed)
 }