Lite


Description

This endpoint allows users to get basic information of places near a location through a simple lat/lon request, with the possibility to filter the results by categories. It consists of a main endpoint to look for places, and secondary endpoints that serve lists of the different kinds of categories available.

All endpoints' urls have the prefix


Stats endpoint

This endpoint returns a counter of the number of places found in the region. If a filter is provided, then the number of places, as well as their names, are returned per filter.

Query parameters
  • lat: latitude in decimal form.
  • lon: latitude in decimal form.
  • radius: radius for the query, in metres (optional).
  • filter_type: (optional; works alongside filter_type_id)
    • subcat: Filters places by the Types associated to a specific AppSubCategory
    • mtype: Filters places by the Types associated to a specific MasterType
    • type: Filters places by their Types
  • filter_type_ids: Comma separated list of filter type ids (optional; works alongside filter_type)


Example Request

GET http://api.fiz.com/content/api/v2/lite/stats/
Content-Type: application/json
QueryString: lon=-0.1440494&lat=51.5118966&radius=1000&filter_type_ids=503,946,958,1224,947&filter_type=type
FIZAPIKEY: BRAND_API_KEY

Response description:

A JSON object is returned. This starts with a dictionary that contains the number of places found, and the search region. Optionally, it could contain details of the places.

This contains the following fields:

  • total_places_count: Total number of places
  • lat: The input latitude of the center of coordinates.
  • lon: The input longitude of the center of coordinates.
  • radius: The radius used for the search (more details below).
  • groupings: A list of JSON objects, one per filter_type_id provided, indicating the number of places found, as well as their names and placelet_ids.


Example Response

{
  "lon": -0.1440494,
  "radius": 1000,
  "total_places_count": 19,
  "lat": 51.5118966,
  "groupings": [
    {
      "count": 3,
      "places": [
        {
          "place": "Handel House",
          "id": 45978,
          "placelet_id": "kjNwHLH9ibipiV",
          "distance": 190
        },
        {
          "place": "Royal Academy of Arts",
          "id": 20156,
          "placelet_id": "OkogsJHAiGi8iz",
          "distance": 476
        },
        {
          "place": "Ripley's Believe it Or Not",
          "id": 44558,
          "placelet_id": "GDYRIYHZiGi8iO",
          "distance": 716
        }
      ],
      "filter": "Museum"
    },
    {
      "count": 5,
      "places": [
        {
          "place": "Berkeley Square",
          "id": 62285,
          "placelet_id": "VLzvT6HQiJijiz",
          "distance": 276
        },
        {
          "place": "Cavendish Square Garden",
          "id": 78946,
          "placelet_id": "wDLyHMH6iViniL",
          "distance": 517
        },
        {
          "place": "Grosvenor Square",
          "id": 59311,
          "placelet_id": "v5BgI9H0i6ivi7",
          "distance": 527
        },
        {
          "place": "Green Park",
          "id": 4294,
          "placelet_id": "o4xWFEHQiMiki4",
          "distance": 830
        },
        {
          "place": "Soho Square",
          "id": 60485,
          "placelet_id": "VxQ8C6HQiJijiz",
          "distance": 906
        }
      ],
      "filter": "Park"
    },
    {
      "count": 3,
      "places": [
        {
          "place": "Spencer House",
          "id": 44296,
          "placelet_id": "E0WGsBHVioiaib",
          "distance": 743
        },
        {
          "place": "Leicester Square",
          "id": 989,
          "placelet_id": "B0jhoH9iJiwiG",
          "distance": 961
        },
        {
          "place": "Horse At Water Sculpture",
          "id": 9634,
          "placelet_id": "kmwwiLH9ibipiV",
          "distance": 978
        }
      ],
      "filter": "Landmark"
    },
    {
      "count": 1,
      "places": [
        {
          "place": "New Bond Street",
          "id": 79533,
          "placelet_id": "JPgZTgHdikiyiZ",
          "distance": 135
        }
      ],
      "filter": "Shopping"
    },
    {
      "count": 8,
      "places": [
        {
          "place": "Sotheby's",
          "id": 79515,
          "placelet_id": "9B1JSpHAiYigiB",
          "distance": 18
        },
        {
          "place": "Halcyon Gallery",
          "id": 44295,
          "placelet_id": "D0VOtdHgini7im",
          "distance": 54
        },
        {
          "place": "Bonhams",
          "id": 118200,
          "placelet_id": "zaYNWsdHmilivi7",
          "distance": 208
        },
        {
          "place": "Timothy Taylor Gallery",
          "id": 43690,
          "placelet_id": "wkzMcMH6iViniL",
          "distance": 419
        },
        {
          "place": "Royal Academy of Arts",
          "id": 20156,
          "placelet_id": "OkogsJHAiGi8iz",
          "distance": 476
        },
        {
          "place": "Photographers' Gallery",
          "id": 101107,
          "placelet_id": "DYy57UdHgini7im",
          "distance": 483
        },
        {
          "place": "Albermarle Gallery",
          "id": 44294,
          "placelet_id": "ok1JCEHQiMiki4",
          "distance": 541
        },
        {
          "place": "The Wallace Collection",
          "id": 53965,
          "placelet_id": "PG9bCnH0iLi1ik",
          "distance": 837
        }
      ],
      "filter": "Art Gallery"
    }
  ]
}


Places endpoint

This endpoint accepts the same query_params as the /stats endpoint, but returns details of the places, such as its name, types, coordinates, distance to center of coordinates, placelet_id, etc.

The response is paginated, indicating a link to the next/previous page, and the total number of results.


Example Request

GET http://api.fiz.com/content/api/v2/lite/places/
Content-Type: application/json
QueryString: lon=-0.1440494&lat=51.5118966&radius=1000&filter_type_ids=503,946,958,1224,947&filter_type=type
FIZAPIKEY: BRAND_API_KEY


Example Response

{
  "count": 19,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "79515",
      "name": "Sotheby's",
      "lat": 51.51181180552441,
      "lon": -0.143835769551701,
      "placelet_id": "9B1JSpHAiYigiB",
      "distance": 17,
      "types": [
        {
          "name": "Landmark",
          "id": 1249,
          "provider": "Wikipedia"
        },
        {
          "name": "Art Gallery",
          "id": 947,
          "provider": "Fiz"
        }
      ],
      "master_types": [
        {
          "name": "Art Galleries",
          "id": 45
        }
      ],
      "sub_categories": [
        {
          "name": "Museums & Galleries",
          "id": 26
        }
      ]
    },
    {
      "id": "44295",
      "name": "Halcyon Gallery",
      "lat": 51.511450042001,
      "lon": -0.14374749204472,
      "placelet_id": "D0VOtdHgini7im",
      "distance": 53,
      "types": [
        {
          "name": "Landmark",
          "id": 1249,
          "provider": "Wikipedia"
        },
        {
          "name": "Art Gallery",
          "id": 947,
          "provider": "Fiz"
        }
      ],
      "master_types": [
        {
          "name": "Art Galleries",
          "id": 45
        }
      ],
      "sub_categories": [
        {
          "name": "Museums & Galleries",
          "id": 26
        }
      ]
    },
    {
      "id": "79533",
      "name": "New Bond Street",
      "lat": 51.510869410902,
      "lon": -0.14301081873744,
      "placelet_id": "JPgZTgHdikiyiZ",
      "distance": 134,
      "types": [
        {
          "name": "Shopping",
          "id": 1224,
          "provider": "Fiz"
        },
        {
          "name": "Exclusive Shop",
          "id": 498,
          "provider": "Fiz"
        }
      ],
      "master_types": [
        {
          "name": "Shopping",
          "id": 36
        },
        {
          "name": "Exclusive Shop",
          "id": 40
        }
      ],
      "sub_categories": [
        {
          "name": "Shopping",
          "id": 17
        }
      ]
    },
    {
      "id": "45978",
      "name": "Handel House",
      "lat": 51.51305799477633,
      "lon": -0.1460559999796678,
      "placelet_id": "kjNwHLH9ibipiV",
      "distance": 189,
      "types": [
        {
          "name": "Museum",
          "id": 503,
          "provider": "Fiz"
        }
      ],
      "master_types": [
        {
          "name": "Museums",
          "id": 38
        }
      ],
      "sub_categories": [
        {
          "name": "Museums & Galleries",
          "id": 26
        }
      ]
    },
    {
      "id": "118200",
      "name": "Bonhams",
      "lat": 51.5132,
      "lon": -0.146204,
      "placelet_id": "zaYNWsdHmilivi7",
      "distance": 207,
      "types": [
        {
          "name": "Art Gallery",
          "id": 947,
          "provider": "Fiz"
        }
      ],
      "master_types": [
        {
          "name": "Art Galleries",
          "id": 45
        }
      ],
      "sub_categories": [
        {
          "name": "Museums & Galleries",
          "id": 26
        }
      ]
    },
    {
      "id": "62285",
      "name": "Berkeley Square",
      "lat": 51.50969043315236,
      "lon": -0.145890340675043,
      "placelet_id": "VLzvT6HQiJijiz",
      "distance": 276,
      "types": [
        {
          "name": "Landmark",
          "id": 1249,
          "provider": "Wikipedia"
        },
        {
          "name": "Park",
          "id": 946,
          "provider": "Fiz"
        },
        {
          "name": "Square",
          "id": 964,
          "provider": "Fiz"
        }
      ],
      "master_types": [
        {
          "name": "Outdoors",
          "id": 19
        },
        {
          "name": "Parks",
          "id": 33
        }
      ],
      "sub_categories": [
        {
          "name": "Nature & Outdoors",
          "id": 3
        }
      ]
    },
    {
      "id": "43690",
      "name": "Timothy Taylor Gallery",
      "lat": 51.51037199477601,
      "lon": -0.1495869999791725,
      "placelet_id": "wkzMcMH6iViniL",
      "distance": 419,
      "types": [
        {
          "name": "Art Gallery",
          "id": 947,
          "provider": "Fiz"
        },
        {
          "name": "Art Venue",
          "id": 948,
          "provider": "Fiz"
        },
        {
          "name": "Art Museum",
          "id": 304,
          "provider": "Foursquare"
        }
      ],
      "master_types": [
        {
          "name": "Museums",
          "id": 38
        },
        {
          "name": "Art Galleries",
          "id": 45
        }
      ],
      "sub_categories": [
        {
          "name": "Museums & Galleries",
          "id": 26
        }
      ]
    },
    {
      "id": "20156",
      "name": "Royal Academy of Arts",
      "lat": 51.5088130294,
      "lon": -0.1392682915610127,
      "placelet_id": "OkogsJHAiGi8iz",
      "distance": 476,
      "types": [
        {
          "name": "Landmark",
          "id": 1249,
          "provider": "Wikipedia"
        },
        {
          "name": "Attraction",
          "id": 499,
          "provider": "Fiz"
        },
        {
          "name": "Art Gallery",
          "id": 947,
          "provider": "Fiz"
        },
        {
          "name": "Museum",
          "id": 503,
          "provider": "Fiz"
        }
      ],
      "master_types": [
        {
          "name": "Attractions",
          "id": 6
        },
        {
          "name": "Museums",
          "id": 38
        },
        {
          "name": "Art Galleries",
          "id": 45
        }
      ],
      "sub_categories": [
        {
          "name": "Attractions & Landmarks",
          "id": 19
        },
        {
          "name": "Museums & Galleries",
          "id": 26
        }
      ]
    },
    {
      "id": "101107",
      "name": "Photographers' Gallery",
      "lat": 51.514933820639,
      "lon": -0.13906449079561,
      "placelet_id": "DYy57UdHgini7im",
      "distance": 482,
      "types": [
        {
          "name": "Landmark",
          "id": 1249,
          "provider": "Wikipedia"
        },
        {
          "name": "Art Gallery",
          "id": 947,
          "provider": "Fiz"
        }
      ],
      "master_types": [
        {
          "name": "Art Galleries",
          "id": 45
        }
      ],
      "sub_categories": [
        {
          "name": "Museums & Galleries",
          "id": 26
        }
      ]
    },
    {
      "id": "78946",
      "name": "Cavendish Square Garden",
      "lat": 51.516501030245244,
      "lon": -0.14511254733181986,
      "placelet_id": "wDLyHMH6iViniL",
      "distance": 517,
      "types": [
        {
          "name": "Park",
          "id": 946,
          "provider": "Fiz"
        }
      ],
      "master_types": [
        {
          "name": "Outdoors",
          "id": 19
        },
        {
          "name": "Parks",
          "id": 33
        }
      ],
      "sub_categories": [
        {
          "name": "Nature & Outdoors",
          "id": 3
        }
      ]
    },
    {
      "id": "59311",
      "name": "Grosvenor Square",
      "lat": 51.511354753992414,
      "lon": -0.1516114925039302,
      "placelet_id": "v5BgI9H0i6ivi7",
      "distance": 526,
      "types": [
        {
          "name": "Landmark",
          "id": 1249,
          "provider": "Wikipedia"
        },
        {
          "name": "Park",
          "id": 946,
          "provider": "Fiz"
        }
      ],
      "master_types": [
        {
          "name": "Outdoors",
          "id": 19
        },
        {
          "name": "Parks",
          "id": 33
        }
      ],
      "sub_categories": [
        {
          "name": "Nature & Outdoors",
          "id": 3
        }
      ]
    },
    {
      "id": "44294",
      "name": "Albermarle Gallery",
      "lat": 51.50755399477659,
      "lon": -0.140520999980449,
      "placelet_id": "ok1JCEHQiMiki4",
      "distance": 541,
      "types": [
        {
          "name": "Attraction",
          "id": 499,
          "provider": "Fiz"
        },
        {
          "name": "Art Gallery",
          "id": 947,
          "provider": "Fiz"
        }
      ],
      "master_types": [
        {
          "name": "Attractions",
          "id": 6
        },
        {
          "name": "Art Galleries",
          "id": 45
        }
      ],
      "sub_categories": [
        {
          "name": "Attractions & Landmarks",
          "id": 19
        },
        {
          "name": "Museums & Galleries",
          "id": 26
        }
      ]
    },
    {
      "id": "44558",
      "name": "Ripley's Believe it Or Not",
      "lat": 51.510109994776066,
      "lon": -0.134107999981325,
      "placelet_id": "GDYRIYHZiGi8iO",
      "distance": 716,
      "types": [
        {
          "name": "Museum",
          "id": 503,
          "provider": "Fiz"
        }
      ],
      "master_types": [
        {
          "name": "Museums",
          "id": 38
        }
      ],
      "sub_categories": [
        {
          "name": "Museums & Galleries",
          "id": 26
        }
      ]
    },
    {
      "id": "44296",
      "name": "Spencer House",
      "lat": 51.505851994776606,
      "lon": -0.139471999980583,
      "placelet_id": "E0WGsBHVioiaib",
      "distance": 743,
      "types": [
        {
          "name": "Historic Building",
          "id": 953,
          "provider": "Fiz"
        },
        {
          "name": "Landmark",
          "id": 958,
          "provider": "Fiz"
        }
      ],
      "master_types": [
        {
          "name": "Attractions",
          "id": 6
        },
        {
          "name": "Monument/Landmark",
          "id": 25
        }
      ],
      "sub_categories": [
        {
          "name": "Attractions & Landmarks",
          "id": 19
        }
      ]
    },
    {
      "id": "4294",
      "name": "Green Park",
      "lat": 51.5044301947767,
      "lon": -0.143966499979963,
      "placelet_id": "o4xWFEHQiMiki4",
      "distance": 830,
      "types": [
        {
          "name": "Attraction",
          "id": 499,
          "provider": "Fiz"
        },
        {
          "name": "Park",
          "id": 946,
          "provider": "Fiz"
        }
      ],
      "master_types": [
        {
          "name": "Attractions",
          "id": 6
        },
        {
          "name": "Outdoors",
          "id": 19
        },
        {
          "name": "Parks",
          "id": 33
        }
      ],
      "sub_categories": [
        {
          "name": "Nature & Outdoors",
          "id": 3
        },
        {
          "name": "Attractions & Landmarks",
          "id": 19
        }
      ]
    },
    {
      "id": "53965",
      "name": "The Wallace Collection",
      "lat": 51.51707812578231,
      "lon": -0.1528280969908393,
      "placelet_id": "PG9bCnH0iLi1ik",
      "distance": 837,
      "types": [
        {
          "name": "Art Gallery",
          "id": 947,
          "provider": "Fiz"
        }
      ],
      "master_types": [
        {
          "name": "Art Galleries",
          "id": 45
        }
      ],
      "sub_categories": [
        {
          "name": "Museums & Galleries",
          "id": 26
        }
      ]
    },
    {
      "id": "60485",
      "name": "Soho Square",
      "lat": 51.515314157577045,
      "lon": -0.132168159354849,
      "placelet_id": "VxQ8C6HQiJijiz",
      "distance": 905,
      "types": [
        {
          "name": "Landmark",
          "id": 1249,
          "provider": "Wikipedia"
        },
        {
          "name": "Park",
          "id": 946,
          "provider": "Fiz"
        }
      ],
      "master_types": [
        {
          "name": "Outdoors",
          "id": 19
        },
        {
          "name": "Parks",
          "id": 33
        }
      ],
      "sub_categories": [
        {
          "name": "Nature & Outdoors",
          "id": 3
        }
      ]
    },
    {
      "id": "989",
      "name": "Leicester Square",
      "lat": 51.510963194776,
      "lon": -0.130244299981867,
      "placelet_id": "B0jhoH9iJiwiG",
      "distance": 960,
      "types": [
        {
          "name": "Attraction",
          "id": 499,
          "provider": "Fiz"
        },
        {
          "name": "Landmark",
          "id": 958,
          "provider": "Fiz"
        }
      ],
      "master_types": [
        {
          "name": "Attractions",
          "id": 6
        },
        {
          "name": "Monument/Landmark",
          "id": 25
        }
      ],
      "sub_categories": [
        {
          "name": "Attractions & Landmarks",
          "id": 19
        }
      ]
    },
    {
      "id": "9634",
      "name": "Horse At Water Sculpture",
      "lat": 51.51365270000001,
      "lon": -0.1579003999999983,
      "placelet_id": "kmwwiLH9ibipiV",
      "distance": 978,
      "types": [
        {
          "name": "Landmark",
          "id": 958,
          "provider": "Fiz"
        },
        {
          "name": "Attraction",
          "id": 499,
          "provider": "Fiz"
        },
        {
          "name": "Landmarks & Historical Buildings",
          "id": 798,
          "provider": "Yelp"
        }
      ],
      "master_types": [
        {
          "name": "Attractions",
          "id": 6
        },
        {
          "name": "Monument/Landmark",
          "id": 25
        }
      ],
      "sub_categories": [
        {
          "name": "Attractions & Landmarks",
          "id": 19
        }
      ]
    }
  ]
}


PlaceletID

A placelet is a standalone output of content, which is unique to the brand for any given place. The content displayed is based upon a ‘plan’ which is set up in the system. Any additional ‘brand content’, which has been added, is included in the output.

It can be accessed by either by directly adding the placelet ID to this URL:

https://api.fiz.com/placelet/[placelet_id]

A placelet may also be embedded on a web page or app, with the following code:

<script data-fiz-text="link text" data-fiz-id="[placelet_id]" src="//d18kn9b1ystsks.cloudfront.net/placelet.js" async></script>

For more information relating to widgets and placelet integration, download our fiz-guide-to-embed-instant-content.pdf

Note. Your content plan may not be configured to output a PlaceletID. Please contact us if you require this parameter.


Radius

The radius used to delimit the region of search is the one supplied by the user, with the following exceptions:

  • If no radius is provided, a default value of 1000 (metres) is used.
  • If the provided radius is bigger than 50 km, a value of 50000 (metres) is used.


Distance

This value indicates the distance in metres from the place to the center of coordinates provided in the query parameters.


Example usage

This is an example visual representation of how the Lite endpoint could be used to enhance a hotel listing.

lite-api-usage






Please contact support@fiz.com for more information