Categories

Searching

The category/search/ resource lets you search for categories using filters. This resource also enables you to crawl the entire categories database of a particular language when no filter is applied, provided the specification of at least a country code.

Request URL:

GET /api/v2/category/search?api_key={my_api_key}&lang={two_letter_country_code}

Request parameters:

Parameter Type Required Default Description
api_key string True None Your API key
lang string True None Specify the language of the category name - use ISO 3166 alpha2 code (i.e. use “FR” for France)
name string False None Filter cateogries by name
page int False 1 Page number. 30 results per page.

JSON response:

{
    "page"            : "page number (int)",
    "max_page"        : "last page number (int)",
    "count"           : "total number of categories found (int)",
    "categories": [
        {
            "id"                : "category id (string)",
            "code"              : "category code (string)",
            "name"              : "category name in language indicated by country code (string)",
            "ancestors"         : "name(s) of top-level category group(s) (list<string>)",
            "partners" : {
                "foursquare"         : "category id(s) on Foursquare partner's API (list<string>)",
                "waze"               : "category id(s) on Waze partner's API (list<string>)",
                "apple"              : "category id(s) on Apple partner's API (list<string>)",
                "le118000" : [
                    {
                        "id"             : "category id on Le 118000 partner's API (string)",
                        "name"           : "category name on Le 118000 partner's API (string)"
                    }
                ],
                "les_horaires"       : "category id(s) on Les Horaires partner's API (list<string>)",
                "navads"             : "category id(s) on Navads partner's API (list<string>)",
                "tomtom"             : "category id(s) on Tom Tom partner's API (list<string>)",
                "google_my_business" : "category id(s) on Google My Business partner's API (list<string>)",
                "facebook"           : "category id(s) on Facebook partner's API (list<string>)",
                "justacote"          : "category id(s) on Just A Coté partner's API (list<string>)",
                "factual"            : "category id(s) on Factual partner's API (list<string>)",
                "dismoiou"           : "category id(s) on Dis Moi Où partner's API (list<string>)"
            }
        }
    ]
}

Getting details

The category/{categoryId} resource lets you get details for the given category.

Request URL:

GET /api/v2/category/{categoryId}?api_key={my_api_key}&lang={two_letter_country_code}

Request parameters:

Parameter Type Required Default Description
api_key string True None Your API key
lang string True None Specify the language of the category name - use ISO 3166 alpha2 code (i.e. use “FR” for France)

JSON response:

{
    "id"                : "category id (string)",
    "code"              : "category code (string)",
    "name"              : "category name in language indicated by country code (string)",
    "ancestors"         : "name(s) of top-level category group(s) (list<string>)",
    "partners" : {
        "foursquare"         : "category id(s) on Foursquare partner's API (list<string>)",
        "waze"               : "category id(s) on Waze partner's API (list<string>)",
        "apple"              : "category id(s) on Apple partner's API (list<string>)",
        "le118000" : [
            {
                "id"             : "category id on Le 118000 partner's API (string)",
                "name"           : "category name on Le 118000 partner's API (string)"
            }
        ],
        "les_horaires"       : "category id(s) on Les Horaires partner's API (list<string>)",
        "navads"             : "category id(s) on Navads partner's API (list<string>)",
        "tomtom"             : "category id(s) on Tom Tom partner's API (list<string>)",
        "google_my_business" : "category id(s) on Google My Business partner's API (list<string>)",
        "facebook"           : "category id(s) on Facebook partner's API (list<string>)",
        "justacote"          : "category id(s) on Just A Coté partner's API (list<string>)",
        "factual"            : "category id(s) on Factual partner's API (list<string>)",
        "dismoiou"           : "category id(s) on Dis Moi Où partner's API (list<string>)"
    }
}