Auxiliary information

Types of ad spaces

Parameters

HTTP method	Access rights	URL	Parameters	Note
GET	public_data	`https://api.admitad.com/websites/kinds/`	offset limit	Returns the types of ad spaces*.

* Returns the result in the JSON format.
**Sets skipping and the number of records returned. For example limit=5&offset=2.

Example of use

Example of a request with utility ``curl``:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/websites/kinds/

Example of the response from the API server in the JSON format:

{

    "results": [

        "website",

        "doorway",

        "contextual",

        "social_app",

        "social_group"

    ],

    "_meta": {

        "count": 7,

        "limit": 5,

        "offset": 0

    }

}

Ad space regions

Parameters

HTTP method	Access rights	URL	Parameters	Note
GET	public_data	`https://api.admitad.com/websites/regions/`	offset limit	Returns the list of regions*.

* Returns the result in the JSON format.
** Sets skipping and the number of records returned. For example limit=5&offset=2.

Example of use

Example of a request with utility ``curl``:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/websites/regions/

Example of the response from the API server in the JSON format:

{

    "results": [

        "RU",

        "UA",

        "BY"

    ],

    "_meta": {

        "count": 20,

        "limit": 3,

        "offset": 0

    }

}

Additional regions

01 — CIS

00 — All

Categories of affiliate programs

Parameters

HTTP method	Access rights	URL	Parameters	Note
GET	public_data	`https://api.admitad.com/categories/`	offset limit campaign* language order_by***	Returns the list of affiliate programs categories*.
GET	public_data	`https://api.admitad.com/categories/advcampaign/{id}`/	offset limit language* order_by***	Returns the list of categories of an affiliate program, where id is the affiliate program identifier*.
GET	public_data	`https://api.admitad.com/categories/{id}/`	language****	Returns the category of an affiliate program, where id is the category identifier*.

* Returns the result in the JSON format.
** Sets skipping and the number of records returned. For example limit=5&offset=2.
*** Filter by affiliate programs. For example, campaign=3&campaign=4, where the values are identifiers of affiliate programs.
**** The language of the response. For example, language=de, where values are two-letter codes.
***** Sorting order. Possible values:
- name
Sign "-" before the value means inverse sort order. For example, order_by=-name.

Example of use

Example of a request with utility ``curl``:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/categories/



curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/categories/12/



curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/categories/advcampaign/6/

Example of the response from the API server in the JSON format:

{

    "results": [

        {

            "name": "Browser",

            "language": "en",

            "parent": {

                "name": "Online Games",

                "language": "en",

                "parent": null,

                "id": 2

            },

            "id": 3

        },

        {

            "name": "Other",

            "language": "en",

            "parent": null,

            "id": 5

        },

        {

            "name": "Client",

            "language": "en",

            "parent": {

                "name": "Online Games",

                "language": "en",

                "parent": null,

                "id": 2

            },

            "id": 4

        }

    ],

    "_meta": {

        "count": 11,

        "limit": 3,

        "offset": 0

    }

}

Description of API server response fields

Name	Description
id	Category ID
name	Name of category
language	Response language
parent	The identifier of the parent category

System languages

Parameters

HTTP method	Access rights	URL	Parameters	Note
GET	public_data	`https://api.admitad.com/languages/`	offset limit	Returns the list of available languages*.
GET	public_data	`https://api.admitad.com/languages/{code}/`		Returns the language, where code is the code of the language (language_code)*.

* Returns the result in the JSON format.
** Sets skipping and the number of records returned. For example limit=5&offset=2.

Example of use

Example of a request with utility ``curl``:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/websites/languages/?limit=2

Example of the response from the API server in the JSON format:

{

    "results": [

        {

            "flag": "http://admitad.com/media/images/flags/c8ef33a926799c7c3d7103212a78b187.png",

            "language": "Русский",

            "language_code": "ru"

        },

        {

            "flag": "http://admitad.com/media/images/flags/a8ef33a926799c7c3d7122222a78b187.png",

            "language": "Deutsch",

            "language_code": "de"

        }

    ],

    "_meta": {

        "count": 2,

        "limit": 2,

        "offset": 0

    }

}

Description of API server response fields

Name	Description
flag	Language flag image
languages	Name of language
language_code	Language code

System currencies

Parameters

HTTP method	Access rights	URL	Parameters	Note
GET	public_data	`https://api.admitad.com/currencies/`	limit offset	Returns the list of currencies*.

* Returns the result in the JSON format.
** Sets skipping and the number of records returned. For example limit=5&offset=2.

Example of use

Example of a request with utility ``curl``:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/currencies/

Example of the response from the API server in the JSON format:

{
    "results": [

        {

            "code": "EUR",

            "min_sum": "20.00",

            "name": "Euro",

            "sign": "€"

        },

        {

            "code": "RUB",

            "min_sum": "750.00",

            "name": "Russian ruble",

            "sign": "руб."

        },

        {

            "code": "USD",

            "min_sum": "25.00",

            "name": "American dollar",

            "sign": "$"

        }

    ],

    "_meta": {

        "count": 3,

        "limit": 20,

        "offset": 0

    }

}

Description of API server response fields

Name	Description
code	Currency code
name	Name of currency
sign	Currency symbol
min_sum	The minimum amount allowed for withdrawal

Exchange rates

Parameters

HTTP method	Access rights	URL	Note
GET	public_data	`https://api.admitad.com/currencies/rate/`	Returns the exchange rate for the selected currency pair.

List of GET-parameters for a request

Name	Description
base	Source currency code (System currencies)
target	Destination currency code (System currencies)
date	Date of the exchange rate in the dd.mm.yyyy format

All parameters are required.
Currency codes should be provided as defined by ISO 4217.

List of response fields

Name	Description
base	Source currency code (System currencies)
target	Destination currency code (System currencies)
date	Date of the exchange rate
rate	Exchange rate (base * rate = target)

Currency codes should be provided as defined by ISO 4217.

Example of a request with utility ``curl``:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/currencies/rate/?base=EUR&target=USD&date=24.06.2014

Example of the response from the API server in the JSON format:

{

    "date": "2014-06-24",

    "rate": "1.3600000000",

    "base": "EUR",

    "target": "USD"

}

Traffic sources

Parameters

HTTP method	Access rights	URL	Parameters	Note
GET	public_data	`https://api.admitad.com/traffic/`	offset limit	Returns available traffic sources*.

* Returns the result in the JSON format.
** Sets skipping and the number of records returned. For example limit=5&offset=2.

Example of use

Example of a request with utility ``curl``:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/traffic/

Example of the response from the API server in the JSON format:

{

    "results": [

        {

            "name": "Cashback",

            "id": 1

        },

        {

            "name": "PopUp / ClickUnder",

            "id": 2

        },

        {

            "name": "Doorway pages",

            "id": 4

        },

        {

            "name": "E-Mail-Marketing",

            "id": 5

        },

        {

            "name": "Brand-Bidding",

            "id": 6

        },

        {

            "name": "Social Media",

            "id": 7

        },

        {

            "name": "Toolbar",

            "id": 9

        },

        {

            "name": "Adult",

            "id": 14

        },

        {

            "name": "Banner-teaser networks",

            "id": 18

        },

        {

            "name": "YouTube Channel",

            "id": 19

        },

        {

            "name": "Брокерский трафик",

            "id": 20

        }

    ],

    "_meta": {

        "count": 11,

        "limit": 20,

        "offset": 0

    }

}