The imin Platform
2.0.0
2.0.0
  • Introduction to the imin Platform
  • Using the Platform
    • imin's Platform Products
    • Authentication
    • Our Platform Data
      • Understanding Responses
      • Namespaces and Extensions
      • Defensive Data Consumption
      • Mocking the Interface
  • platform products
    • Search
      • imin Events API
        • Events API Reference
        • Virtual & Physical Sessions
        • Concepts
          • EventSeries
          • ScheduledSessions and eventSchedules
          • Activities and Collections
            • Activities
            • Activity Concept Collections
          • Accessibility Support
          • Prices
        • Filters
          • Modes
          • Age Ranges
          • Dates and Times
          • Activities and Concept Collections
          • High Frequency Sessions
      • imin Facilities API
        • Query Parameter Search
          • Mandatory Query Parameters
            • mode=discovery-geo
            • mode=upcoming-slots
          • Optional Query Parameters
        • ByID Search
          • FacilityUse By-ID
          • Slot By-ID
        • FacilityUses and IndividualFacilityUses
        • Slots
        • Facilities Slot Booking
      • imin Places API [BETA]
        • Example Request & Response
    • Firehose
      • Introduction to the Firehose
      • Accessing the Firehose
      • Firehose Usage Policy & Restrictions
      • Firehose and Search
      • Bookable Firehose Feeds
      • Bookable Sellers Feed
      • Attribution Catalog Endpoint
    • Live Timetables
      • Pre-Requisites: Open Data Feeds
      • The Onboarding Process
        • 1. Ensuring your Data Offers the Best User Experience
        • 2. Setting up and Embedding your First Timetable
        • 3. Setting up the Rest of your Timetables
        • 4. Activating Booking via Guest Checkout
      • Features Available Upon Request
      • Styling the Live Timetables
      • FAQs
    • Data Dashboard
  • incorporating book and pay
    • imin Branded Checkout
      • Introduction
      • Setup
        • Information We Require From You
        • Actions You Need to Complete
      • Authenticated Checkout
        • Testing [BETA]
        • 👪Group Booking [BETA]
      • Standalone Checkout
      • Firehose and Checkout [BETA]
        • Loading the Checkout via Firehose
    • imin Booking Platform
      • Customer Account Management
        • Create Customer Account
        • Update Customer Account
        • Get Customer Account
        • Delete Customer Account
        • Example Scenario
        • Payment Card Management
        • Linked Accounts
        • Entitlement
          • Evidence Requests
          • Entitlement Pricing in Search
          • Entitlement Pricing in Checkout
        • Access Pass
        • Webhooks
      • Orders
        • Order History
        • Order (by ID)
        • Cancellations & Refunds
      • Upcoming OrderItems
      • Receipt (by ID)
  • imin and booking systems
    • Seller Onboarding
      • API
  • HINTS & TIPS
    • Get the Best Out of Search
      • Displaying Schedule Information
      • URLs and Offering a Call to Action
      • Searching by Activity
      • Your Search Results and HighFrequencySessions
      • Customer Specific Images
  • Info for Data Publishers
    • Your RPDE Feed & the imin Platform [BETA]
      • Providing Places Data [BETA]
      • Providing Schedule Information [BETA]
Powered by GitBook
On this page
  1. platform products
  2. Search
  3. imin Places API [BETA]

Example Request & Response

Get Places

GET https://places.imin.co/api/v1/places

Query Parameters

Name
Type
Description

page

number

Which page of results to return

limit

number

How many results to return on each page

geo[radial]

string

Filters for Places within the radial circle Format: {latitude},{longitude},{radius} Radius is in km

placeClassification

string

Whether the Place is a park or a leisure centre Allowed values are mcr:Park and mcr:LeisureCentre

activityId

string

Whether the activity specified occurs at the Place Must be an encoded OpenActive Activity ID, e.g. https%3A%2F%2Fopenactive.io%2Factivity-list%23f2ea7405-6098-4378-b0fe-4e398a659fc4

Headers

Name
Type
Description

X-Api-Key

string

Authentication token

{
  "@context": [
    "https://openactive.io/",
    "https://schema.imin.co/",
    "https://openactive.io/ns-beta",
    "https://data.mcractive.com/ns/mcr.jsonld"
  ],
  "id": "https://places.imin.co/api/v1/places?geo%5Bradial%5D=52.5,-2.2,100&limit=50&activity=https%3A%2F%2Fopenactive.io%2Factivity-list%23fbdc35a8-3dd0-40ee-a7ca-6ff40b3e5f90",
  "type": "imin:RestrictedCollection",
  "imin:totalItems": 1,
  "view": {
    "id": "https://places.imin.co/api/v1/places?geo%5Bradial%5D=52.5%2C-2.2%2C100&activity=https%3A%2F%2Fopenactive.io%2Factivity-list%23fbdc35a8-3dd0-40ee-a7ca-6ff40b3e5f90&limit=50&page=1",
    "type": "PartialCollectionView",
    "first": "https://places.imin.co/api/v1/places?geo%5Bradial%5D=52.5%2C-2.2%2C100&activity=https%3A%2F%2Fopenactive.io%2Factivity-list%23fbdc35a8-3dd0-40ee-a7ca-6ff40b3e5f90&limit=50&page=1",
    "last": "https://places.imin.co/api/v1/places?geo%5Bradial%5D=52.5%2C-2.2%2C100&activity=https%3A%2F%2Fopenactive.io%2Factivity-list%23fbdc35a8-3dd0-40ee-a7ca-6ff40b3e5f90&limit=50&page=1",
    "imin:currentPage": 1,
    "imin:itemsPerPage": 50,
    "imin:totalPages": 1,
    "urlTemplate": "https://places.imin.co/api/v1/places?geo%5Bradial%5D=52.5%2C-2.2%2C100&activity=https%3A%2F%2Fopenactive.io%2Factivity-list%23fbdc35a8-3dd0-40ee-a7ca-6ff40b3e5f90&limit=50&page={page}"
  },
  "imin:item": [
    {
      "geo": {
        "type": "GeoCoordinates",
        "latitude": 53.3744067,
        "longitude": -2.2717618
      },
      "name": "woodhouse park lifestyle centre",
      "type": "Place",
      "image": [
        {
          "url": "https://www.kineticinsightpro.com/media/venues/thumb/1603199463-WCHG-178.jpg",
          "type": "ImageObject",
          "thumbnail": [
            {
              "url": "https://www.kineticinsightpro.com/media/venues/thumb/1603199463-WCHG-178.jpg",
              "type": "ImageObject"
            }
          ]
        }
      ],
  "address": {
    "type": "PostalAddress",
    "postalCode": "m221qw",
    "addressRegion": "Manchester",
    "streetAddress": "Woodhouse Park Lifestyle Centre",
    "addressCountry": "GB",
    "addressLocality": "Portway, Manchester"
  },
  "@context": [
    "https://openactive.io/",
    "https://openactive.io/ns-beta",
    "https://data.mcractive.com/ns/mcr.jsonld"
  ],
  "provider": {
    "id": "http://kinetic-insight.com/organizer/746",
    "url": "https://www.woodhouseparklifestylecentre.co.uk/",
    "name": "gll manchester",
    "type": "Organization",
    "email": "mcractive@better.org",
    "sameAs": [
      "https://www.facebook.com/WPLifestyleCent/",
      "https://twitter.com/wplifestylecent?lang=en"
    ],
    "telephone": "0161 641 9911"
  },
  "identifier": "http://opendata.kinetic-insight.com/api/feeds/places/00000000000000003140",
  "description": "Welcome to the Woodhouse Park Lifestyle Centre – a community centre in the heart of Wythenshawe.\r\n\r\nThe centre is open to all – seven days a week, with events and activities for all ages.\r\n\r\nIf you’re looking for things to do in Wythenshawe, drop in to see the great range of activities the centre has on offer. From sports and fitness to arts and computer classes, youth clubs to over 50s get-togethers and football pitch hire- there’s always lots going on.                                                                                          \r\nYou can also hire their event spaces for weddings, business conferences & events, community group use and children’s parties and celebrations. The Centre has full catering and bar facilities, so if you’re looking for a great value venue for your next event, take a look at our excellent facilities with competitive rates.\r\n\r\nWoodhouse Park Lifesyle Centre is managed by Wythenshawe Community Housing Group and is proud to bring together local communities, businesses and partners at the centre to provide opportunities for people from all age groups to socialise, learn, and stay healthy – read more about how they’re making a difference.\r\n\r\n\r\nDue to COVID-19 this facility is closed until further notice.  See https://www.mcractive.com/activity/covid-19 for more information.  \r\n",
  "amenityFeature": [
    {
      "name": "Café",
      "type": "ChangingFacilities",
      "value": true
    },
    {
      "name": "Car Parking",
      "type": "Parking",
      "value": true
    },
    {
      "name": "Single Sex Changing",
      "type": "ChangingFacilities",
      "value": true
    },
    {
      "name": "Toilets",
      "type": "Toilets",
      "value": true
    },
    {
      "name": "Vending",
      "type": "ChangingFacilities",
      "value": true
    },
    {
      "name": "disabled access",
      "type": "LocationFeatureSpecification",
      "value": true
    },
    {
      "name": "disabled changing",
      "type": "LocationFeatureSpecification",
      "value": true
    },
    {
      "name": "disabled parking",
      "type": "LocationFeatureSpecification",
      "value": true
    },
    {
      "name": "disabled toilets",
      "type": "LocationFeatureSpecification",
      "value": true
    }
  ],
  "beta:isAuthoritative": true,
  "mcr:placeClassification": [
    "https://data.mcractive.com/ns#LeisureCentre"
  ],
  "imin:distanceFromGeoQueryCenter": {
    "type": "QuantitativeValue",
    "value": 97.428,
    "unitCode": "KMT"
  },
  "id": "https://places.imin.co/api/v1/places/http%3A%2F%2Fopendata.kinetic-insight.com%2Fapi%2Ffeeds%2Fplaces%2F00000000000000003140",
  "imin:aggregatedActivity": [
    {
      "type": "Concept",
      "prefLabel": "Badminton",
      "id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e"
    },
    {
      "type": "Concept",
      "prefLabel": "Basketball",
      "id": "https://openactive.io/activity-list#e09776e6-f1b4-421b-b667-5c5913cf97aa"
    },
    {
      "type": "Concept",
      "prefLabel": "Netball",
      "id": "https://openactive.io/activity-list#fbdc35a8-3dd0-40ee-a7ca-6ff40b3e5f90"
    },
    {
      "type": "Concept",
      "prefLabel": "Wrestling",
      "id": "https://openactive.io/activity-list#88ba0d3d-ce9e-4ee7-a6e5-2f16c944bfac"
    },
    {
      "type": "Concept",
      "prefLabel": "Martial Arts",
      "id": "https://openactive.io/activity-list#2330f2d4-d0dc-4231-8dd9-07d37a452228"
    },
    {
      "type": "Concept",
      "prefLabel": "Group Exercise",
      "id": "https://openactive.io/activity-list#984068a7-5b7b-4989-bb33-f96953d8960c"
    },
    {
      "type": "Concept",
      "prefLabel": "Gym Workout",
      "id": "https://openactive.io/activity-list#08d9368c-6c6c-44a3-84ef-a42ed00d529a"
    },
    {
      "type": "Concept",
      "prefLabel": "Dance",
      "id": "https://openactive.io/activity-list#6ca15167-51da-4d91-a1ae-8a45dc47b0ea"
    },
    {
    "type": "Concept",
    "prefLabel": "Football",
    "id": "https://openactive.io/activity-list#0a5f732d-e806-4e51-ad40-0a7de0239c8c"
    }
  ]
}

The optional activityId parameter:

  • Must be an encoded URL;

  • Should not be confused with the activityPreflabel parameter used with the Events and Facilities APIs; and

  • Cannot be used more than once in a single API call.

This API documentation is in it's first iteration and will be replaced by a more comprehensive OAS3 specification at a later date.

The data in our Places API is mainly derived from facilities RPDE feeds, but sometimes comes from dedicated places feeds. Therefore, whilst the Facilities API can be used in conjunction with the Places API to check available Slots, we cannot guarantee that there are any sessions associated with a Place in the Places API.

The data in our Places API is not ever derived from the Events API.

The items returned by the Places API will be ordered by distance from the search radius in ascending order.

Important fields from the response:

  • imin:aggregatedActivityId: this is an aggregated field that represents all the activities that occur at a Place.

  • mcr:placeClassification: this field represents whether a Place is a park or a leisure centre. The allowed values are https://data.mcractive.com/ns#LeisureCentreand https://data.mcractive.com/ns#Park

Previousimin Places API [BETA]NextFirehose

Last updated 3 years ago