API Parameters

Complete reference of all available API parameters.

Common Parameters

These parameters are used across multiple API endpoints:

Parameter	Type	Required	Description
`apiKey`	string	Yes	Your application API key
`apiSecret`	string	Yes	Your application API secret (server-side only)
`userId`	string	Yes	Unique identifier for the user (max 256 characters)

Offers Endpoint Parameters

GET /v1/offers

Parameter	Type	Required	Description
`country`	string	No	2-letter ISO country code (e.g., US, GB, FR)
`platform`	string	No	Filter by platform: `web`, `android`, or `ios`
`category`	string	No	Filter by category: `survey`, `app`, `game`, `video`
`limit`	integer	No	Number of offers to return (min: 1, max: 100, default: 20)
`offset`	integer	No	Pagination offset (default: 0)
`sort`	string	No	Sort order: `payout_desc`, `payout_asc`, `newest`, `popular`

Custom Sub-ID Parameters

Track custom data through conversions using sub-ID parameters (returned in postbacks):

Parameter	Type	Max Length	Description
`aff_sub`	string	45 chars	Custom tracking parameter #1
`aff_sub2`	string	45 chars	Custom tracking parameter #2
`aff_sub3`	string	45 chars	Custom tracking parameter #3
`aff_sub4`	string	45 chars	Custom tracking parameter #4

Example Request with All Parameters

        GET https://letest.scriptstore.store/api/v1/offers?
            apiKey=YOUR_API_KEY&
            apiSecret=YOUR_API_SECRET&
            userId=USER123&
            country=US&
            platform=mobile&
            category=survey&
            limit=10&
            offset=0&
            sort=payout_desc&
            aff_sub=campaign1&
            aff_sub2=source_a

Parameter Validation

Country codes must be valid 2-letter ISO 3166-1 alpha-2 codes
userId can contain alphanumeric characters, hyphens, and underscores
Age must be between 13 and 99
Limit cannot exceed 100 offers per request
All string parameters are case-insensitive except for userId

Reserved Characters

The following characters should be URL-encoded in parameter values:

Character	URL Encoded
Space	%20 or +
&	%26
=	%3D
?	%3F
#	%23