Places


Description

Places are the core of the Fiz API. A Place record uniquely identifies an individual attraction, point of interest, venue or other leisure place by its ID and contains primary data ranging from the geolocation, types and category, to the record creation date, provider, and the user who created it.

A latitude longitude query Returns a list of nearby places. Where radius is ‘0’ all places within the polygon that correspond to your Plan will be returned.

Only a summary of each place is returned.

Any Brand Content that you have added in your cms will be returned as ‘extraData’.

Results are paginated.

Links for next and previous pages are provided.

The total number of items is also returned as the count attribute.


Query parameters

  • lat: latitude in decimal form.
  • lon: latitude in decimal form.
  • radius: radius for the query, in metres (optional).
  • limit: the number of records to be returned in each page (optional)
  • filter_type: (optional; works alongside filter_type_id)
    • cat: Filters places by the Types associated to a specific AppCategory
    • subcat: Filters places by the Types associated to a specific AppSubCategory
    • mtype: Filters places by the Types associated to a specific MasterType
  • filter_type_ids: Comma separated list of filter type ids (optional; works alongside filter_type)

Provider

The Provider field specifies the data source used to supply the base record. The base record will typically consist of communications data for the place and not the other primary data which, if present, will have been curated or compiled by Fiz.

You will only be able to output places for Providers to whom you have been granted access in your account configuration, subject to any Third Party API keys you may be required to submit to Fiz to use on your behalf.


Attribution

The "attribution_text" field is a compulsory field used to identify the data source with the appropriate credit or attribution. Please refer to any display requirements published by Third Party Content Sources to ensure you comply with their requirements.

Example Request

GET http://api.fiz.com/content/api/v2/places/
Content-Type: application/json
QueryString: lon=-0.081152603&lat=51.499044306&radius=1000&filter_type_ids=61&filter_type=type
FIZAPIKEY: BRAND_API_KEY


Response description

A JSON object is returned. This starts with a meta dictionary that contains paging info and the total count of records in the result.

This contains the following fields:

  • next: The URL for to call for the next page, null if not relevant.
  • previous: The URL to call for the previous page, null if not relevant.
  • count: The number of records in the result set.
  • results: JSON object containing a list of object results.

By default the API returns the results in pages of 20 records at a time. This may vary and should not be assumed.


Example Response

{
"count": 7,
"next": null,
"previous": null,
"results": [
  {
    "id": 459365,
    "lat": 51.5053642343,
    "lon": -0.0797461993895,
    "attribution_text": "Powered by Foursquare",
    "offers": 0,
    "creator": null,
    "types": [
      {
        "created": "2013-05-27T21:25:55.469000Z",
        "name": "Art Gallery",
        "original_id": "4bf58dd8d48988d1e2931735"
      }
    ],
    "provider": "Foursquare",
    "placelet_id": "***************",
    "created": "2015-05-21T10:36:33.007284Z",
    "name": "Tom Stoddart Perspective",
    "canonical_name": "tom stoddart perspective",
    "is_public": true,
    "is_aggregated": true,
    "email": null,
    "web": null,
    "affiliate_link": null,
    "is_flagged": false,
    "rating": null,
    "is_accom": false,
    "misc": null,
    "fiz_approved": false,
    "live": true,
    "extraData": {}
  },
  {
    "id": 425363,
    "lat": 51.5032447157,
    "lon": -0.071500154728,
    "attribution_text": "Powered by Foursquare",
    "offers": 0,
    "creator": null,
    "types": [
      {
        "created": "2013-05-27T21:25:55.469000Z",
        "name": "Art Gallery",
        "original_id": "4bf58dd8d48988d1e2931735"
      }
    ],
    "provider": "Foursquare",
    "placelet_id": "***************",
    "created": "2015-03-10T17:21:41.285999Z",
    "name": "Nokia Exhibition - people made",
    "canonical_name": "nokia exhibition - people made",
    "is_public": true,
    "is_aggregated": true,
    "email": null,
    "web": null,
    "affiliate_link": null,
    "is_flagged": false,
    "rating": null,
    "is_accom": false,
    "misc": null,
    "fiz_approved": false,
    "live": true,
    "extraData": {}
  },
  {
    "id": 425347,
    "lat": 51.5029929138,
    "lon": -0.0720212718361,
    "attribution_text": "Powered by Foursquare",
    "offers": 0,
    "creator": null,
    "types": [
      {
        "created": "2013-05-27T21:25:55.469000Z",
        "name": "Art Gallery",
        "original_id": "4bf58dd8d48988d1e2931735"
      }
    ],
    "provider": "Foursquare",
    "placelet_id": "***************",
    "created": "2015-03-10T17:21:37.847909Z",
    "name": "Louis Khan: The Power Of Architecture",
    "canonical_name": "louis khan: the power of architecture",
    "is_public": true,
    "is_aggregated": true,
    "email": null,
    "web": null,
    "affiliate_link": null,
    "is_flagged": false,
    "rating": null,
    "is_accom": false,
    "misc": null,
    "fiz_approved": false,
    "live": true,
    "extraData": {}
  },
  {
    "id": 89416,
    "lat": 51.5004545111,
    "lon": -0.0843827363286,
    "attribution_text": "Powered by Foursquare",
    "offers": 0,
    "creator": null,
    "types": [
      {
        "created": "2013-05-27T21:25:55.469000Z",
        "name": "Art Gallery",
        "original_id": "4bf58dd8d48988d1e2931735"
      }
    ],
    "provider": "Foursquare",
    "placelet_id": "***************",
    "created": "2014-01-22T11:09:05.569676Z",
    "name": "Hide Gallery",
    "canonical_name": "hide gallery",
    "is_public": true,
    "is_aggregated": true,
    "email": null,
    "web": null,
    "affiliate_link": null,
    "is_flagged": false,
    "rating": null,
    "is_accom": false,
    "misc": null,
    "fiz_approved": false,
    "live": true,
    "extraData": {}
  },
  {
    "id": 72111,
    "lat": 51.498868,
    "lon": -0.08105,
    "attribution_text": "Powered by Foursquare",
    "offers": 0,
    "creator": null,
    "types": [
      {
        "created": "2013-05-27T21:25:55.469000Z",
        "name": "Art Gallery",
        "original_id": "4bf58dd8d48988d1e2931735"
      }
    ],
    "provider": "Foursquare",
    "placelet_id": "***************",
    "created": "2013-12-30T17:37:16.695121Z",
    "name": "Pure & Applied",
    "canonical_name": "pure and applied",
    "is_public": true,
    "is_aggregated": true,
    "email": null,
    "web": null,
    "affiliate_link": null,
    "is_flagged": false,
    "rating": null,
    "is_accom": false,
    "misc": null,
    "fiz_approved": false,
    "live": true,
    "extraData": {}
  },
  {
    "id": 72100,
    "lat": 51.4988710361,
    "lon": -0.0810693678943,
    "attribution_text": "Powered by Foursquare",
    "offers": 0,
    "creator": null,
    "types": [
      {
        "created": "2013-05-27T21:25:55.469000Z",
        "name": "Art Gallery",
        "original_id": "4bf58dd8d48988d1e2931735"
      }
    ],
    "provider": "Foursquare",
    "placelet_id": "***************",
    "created": "2013-12-30T17:37:14.904899Z",
    "name": "167 Bermondsey Street",
    "canonical_name": "167 bermondsey street",
    "is_public": true,
    "is_aggregated": true,
    "email": null,
    "web": null,
    "affiliate_link": null,
    "is_flagged": false,
    "rating": null,
    "is_accom": false,
    "misc": null,
    "fiz_approved": false,
    "live": true,
    "extraData": {}
  },
  {
    "id": 61966,
    "lat": 51.4996613447,
    "lon": -0.0824793463959,
    "attribution_text": "Powered by Foursquare",
    "offers": 0,
    "creator": null,
    "types": [
      {
        "created": "2015-08-06T17:10:13.407333Z",
        "name": "Landmark",
        "original_id": "landmark"
      },
      {
        "created": "2013-05-27T21:25:55.469000Z",
        "name": "Art Gallery",
        "original_id": "4bf58dd8d48988d1e2931735"
      }
    ],
    "provider": "Foursquare",
    "placelet_id": "***************",
    "created": "2013-12-14T18:27:29.724536Z",
    "name": "White Cube",
    "canonical_name": "white cube",
    "is_public": true,
    "is_aggregated": true,
    "email": null,
    "web": null,
    "affiliate_link": null,
    "is_flagged": false,
    "rating": null,
    "is_accom": false,
    "misc": null,
    "fiz_approved": false,
    "live": true,
    "extraData": {}
  }
]

}


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.


General data

Although we continuously strive to provide the best quality data, Fiz cannot and does not warrant the accuracy and validity of ANY data – such is the nature of content curation.


Fiz approved

A ‘Fiz approved’ boolean denotes if our curation team has manually approved a place. Typically this is a quality assured mark.


Score

The ‘score’ value is based on a unique Fiz algorithm, which assess each place for relevance, completeness, accuracy and popularity.

Typically your configuration will only allow places to be displayed, which have a high rating. However it may also be possible for a place to receive a low score, but has been included in your output based on your set-up plan.


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.






Please contact support@fiz.com for more information