API Documentation (v1)¶

The Preads Platform provides a high-performance RESTful API designed for seamless integration with mobile apps, websites, and external dashboards. Our API follows standard HTTP conventions and returns structured JSON responses.

🔑 Authentication¶

Most endpoints require authentication using your App API Key and App API Secret, which can be managed in the Publisher Dashboard.

Authentication Method¶

Include your credentials as query parameters in your GET requests or in the request body for POST requests.

Parameter	Type	Description
`apiKey`	`string`	Your unique application identifier.
`apiSecret`	`string`	Your private secret key (keep this secure).

🎁 Offer Retrieval¶

Retrieve a filtered and sorted list of available offers for your application.

`GET /api/v1/offers`¶

Query Parameters¶

Parameter	Type	Description
`userId`	`string`	(Required) The unique ID of the user viewing the offers.
`country`	`string`	ISO 2-letter country code (e.g., `US`). Defaults to IP-detected country.
`platform`	`string`	`desktop`, `android`, or `ios`. Defaults to IP-detected device.
`category`	`string`	Filter by category slug (e.g., `surveys`, `games`).
`limit`	`int`	Number of offers to return (Max: 100, Default: 20).
`offset`	`int`	Starting offset for pagination.
`sort`	`string`	`payout_desc` (default), `payout_asc`, `newest`.

Sample Response¶

{
    "success": true,
    "data": [
        {
            "offer_id": 1284,
            "name": "Wealthy Survey Pro",
            "description": "Complete your first market research survey.",
            "payout": 1.5,
            "payout_local": 1500,
            "currency": "Points",
            "link": "https://your-domain.com/track?offerId=1284&apiKey=...",
            "image_url": "https://cdn.example.com/logo.png",
            "platforms": ["desktop", "android"]
        }
    ],
    "meta": {
        "total": 45,
        "returned": 1,
        "limit": 20,
        "offset": 0,
        "detected": {
            "country": "US",
            "device": "desktop"
        },
        "timestamp": 1706561400
    }
}

🛡️ Anti-Fraud API¶

The platform includes an advanced fingerprinting system to prevent multi-accounting and bot activities.

`POST /api/v1/fingerprint`¶

Store and analyze device metadata to detect high-risk users.

Request Body¶

{
    "fingerprint_hash": "a1b2c3d4e5f6...",
    "user_id": "USER_123",
    "fingerprint_data": {
        "resolution": "1920x1080",
        "browser": "Chrome",
        "os": "Windows"
    }
}

Response Details¶

is_blocked: Boolean indicating if the device is blacklisted.
risk_score: A value from 0-100 indicating fraud probability.
is_multi_accounting: Indicates if the device is linked to other user IDs.

🔗 Tracking & Postbacks¶

Redirect Tracking¶

To track user conversions, you must use the link provided in the Offers API response.

https://your-domain.com/track?offerId={ID}&apiKey={KEY}&userId={USER_ID}&subId={OPTIONAL}

Receiving Postbacks (S2S)¶

The platform can receive conversion data from 3^rd party networks via a standard S2S Postback.

Base URL: https://your-domain.com/postback
Method: GET or POST
Required Parameters: click_id, payout, status.

🚦 Rate Limiting¶

To ensure platform stability, the API is limited to 60 requests per minute per API key. Exceeding this limit will result in a 429 Too Many Requests response.

Explore Developer Guide →