API Documentation

If you would like us to notify you whenever an offer is completed, set up a server postback.

Our offers API consists of a single API call which retrieves in JSON format a list of all of our available offers. By adding additional URL parameters to the API call URL you may filter the offers returned in a variety of manners. A documentation for all of these options is provided in the text below.
NOTE: Your API key is allowed to make up to 10 calls a minute

https://www.kiwiwall.com/get-offers/{api_key}/?s={sub_id}&s2={sub_id_2}&s3={sub_id_3}&s4={sub_id_4}&s5={sub_id_5}&ip_address={ip_address}&country={country}&category={category}

Parameter	Required	Description	Type
api_key	Required	Your App API Key - Can be found in the Apps section	String
s	Optional	Your user's primary unique identifier.	String
s2	Optional	Your user's secondary unique identifier.	String
s3	Optional	Your user's secondary unique identifier.	String
s4	Optional	Your user's secondary unique identifier.	String
s5	Optional	Your user's secondary unique identifier.	String
ip_address	Optional	Returns offers related to the country associated with a certain IP Address. If non entered we will use the IP address of the API caller.	String
country	Optional	Returns offers filtered by country. Please use "ALL" for all countries. If non entered we will use the ip_address parameter and the default fallback will be the IP address of the API caller. (Please use ISO-3166-1 standard countries)	String
category	Optional	Possible values are: Offer = Regular offer,CC = Shopping Offer,Mobile = Mobile Offer,Daily = Daily Survey,Survey = Survey	String
os	Optional	Possible values are: android = Android Devices,ios = iOS devices	String

Response 200

Content-Type: application/json

{
    "currency":"Coins",
    "offers":
    [{
        "id":"37031",
        "name":"Thumbr Pac Man WAP & Web BE",
        "logo":"https://www.kiwiwall.com/img/offers/p887abw6ox.png",
        "instructions":"Download the Pac Man Game",
        "amount":1250,
        "category":"Mobile",
        "os":"android",
        "link":"https://www.kiwiwall.com/submit-click/6x3xJnYQpajJhxBAC9gxwICmfXRhd2V2/2/37031",
        "countries":"US," //Countries are separated with a comma
        "clicked":false
    }]
}
                        

Our Reports API consists of a single API call which retrieves in JSON format a full report of your working ap. By adding a Start Date and an End Date you may filter the report by the dates you enter. If no date was entered then we will show you a report of today.

https://www.kiwiwall.com/get-reports/{api_key}/?start_date={YYYY-MM-DD}&end_date={YYYY-MM-DD}

Parameter	Required	Description	Type
api_key	Required	Your App API Key - Can be found in the Apps section	String
start_date	Optional	The start date for your report	Date
end_date	Optional	The end date for your report	Date

Response 200

Content-Type: application/json

{
    [{
        "clicks":"500",
        "leads":"250",
        "revenue":"$1000"
    }]
}