Clique Eligibility Overview

This page explains, in simple terms, how a token claim application uses Clique’s allocations API to decide whether a wallet is eligible for a specific allocation (for example an airdrop or points).

The goal is to describe the concepts. The exact request and response format are documented in detail in endpoint.mdx.

What the API Does

The allocations API answers one main question:

“For this wallet, in this campaign, is there an allocation and how large is it?”

A typical token claim UI:

• Takes a connected wallet address.
• Sends it to Clique with the correct campaign identifiers.
• Receives a structured response that contains allocation data.
• Decides whether the wallet is eligible, and displays the result to the user.

Core Concepts

API URL

All allocation checks are sent to a single HTTPS endpoint:

const API_URL = "https://acs-v4.clique.tech/allocations";

Every campaign built on Clique uses this same URL. What changes between campaigns is the content of the request body.

APP_ID

APP_ID identifies the application or campaign inside Clique.

const APP_ID = "<app-id>"; // for example: "rayls"

• Each campaign has its own APP_ID value.
• The value is sent in the request body.
• You must use the exact value configured for the campaign you are checking.

DEPLOYMENT

DEPLOYMENT identifies the deployment or distributor configuration for that app.

const DEPLOYMENT = "<deployment>"; // for example: "Distributor"

• A campaign can have one or more deployments.
• The value is also sent in the request body.
• It must match the value used by the official claim UI.

High-Level Flow

Conceptually, a token claim UI works like this:

1. The user connects a wallet address.
2. The UI prepares a request with:
   • address (wallet address),
   • appId (the APP_ID for this campaign),
   • deployment (the DEPLOYMENT to use).
3. The UI sends a POST request to https://acs-v4.clique.tech/allocations.
4. Clique returns a JSON response with a top-level data array.
5. The UI interprets the response:
   • if data contains an entry with a non-zero allocation, the wallet is considered eligible;
   • otherwise, the wallet is considered not eligible.

What You Can Build

Using this API pattern, you can build:

• A small backend service that checks eligibility for one address at a time.
• A CLI tool that checks many addresses in batch (for example from a CSV file).
• An internal dashboard that shows which wallets are eligible and with what allocation.

For all implementation details, including headers, request body and response fields, see the dedicated reference in endpoint.mdx.