InnerSpace API
  • Overview
  • Metrics and Features
  • Groups
  • Authentication
  • Granularity
  • DateTime
  • GraphQL Playground
  • API Reference (v2)
    • building_insights (nightly)
    • zone_insights (nightly)
    • zone_type_insights (nightly)
    • buildings (nightly)
    • sites (nightly) [TBD]
    • zone_occupancy (realtime) [TBD]
    • zone_occupancy (nightly) [TBD]
    • groups (nightly) [TBD]
    • zones (nightly) [TBD]
  • Deprecated API (2025-05-26)
    • Authentication (v1 - deprecated)
    • API Reference (v1 - deprecated)
      • zone_occupancy (realtime)
      • zone_metrics (nightly)
      • zone_features (nightly)
      • site_metrics (nightly)
      • site_features (nightly)
      • building_metrics (nightly)
      • building_features (nightly)
      • zone_occupancy (nightly)
      • groups (nightly) (TBD)
      • buildings (nightly) (TBD)
      • sites (nightly) (TBD)
      • zones (nightly) (TBD)
Powered by GitBook
On this page
  • Summary
  • Developer Access
  • Backend Services
  • Examples

Was this helpful?

Authentication

How to authenticate to the InnerSpace API

PreviousGroupsNextGranularity

Last updated 6 days ago

Was this helpful?

Summary

API access is available to users via their JWT bearer token, or can be made available to a backend system via an M2M token issued by InnerSpace.

Developer Access

Contact sales@innerspace.io for developer access. They will provide you with a ClientID and ClientSecret.

They will need to know the usage of the credentials - whether it is needed for a backend service, a native application, a single-page web app or regular web app.

Backend Services

Backend services should use the /oauth/token endpoint below, which behaves as documented in the .

Examples

Python Example
# retrieve auth token (cache for reuse)
auth_data = {
    "client_id": 'Your Client ID',
    "client_secret": 'Your Client Secret' }

# auth credentials should be sent as form URL encoded
response = requests.post(url="https://api.innerspace.io/api/rest/oauth/token", json=auth_data, headers={'Content-Type': 'application/json'}
)
access_token = response.json()['oauth_token']['access_token']

# call API using auth token
url_path = 'https://api.innerspace.io'
authorization = f'Bearer {access_token}'

sample_graphql = {
    "operationName": "sample_graphql",
    "variables": {},
    "query": "query sample_graphql { BUILDING_INSIGHTS(where: {DATE_PARTITION: {_eq: 20250501}, BUILDING_ID: {_eq: 71}, GRANULARITY: {_eq: \"PT1H\"}, GROUP_ID: {_eq: \"all-e707b3a8-0732-49ae-9156-13ff1138540e\"}, SITE_ID: {_eq: 900000222}}, order_by: {DATE_TIME_START: desc}) { BUILDING_ID\n DATE_TIME_START\n OCCUPANCY_MEAN\n GRANULARITY\n GROUP_ID\n SITE_ID\n }\n }"

}

response = requests.post(url_path, json=sample_graphql, headers={'Accept': 'application/json', 'Authorization': authorization})
CURL Example
# Retrieving token
curl --request POST \
     --url https://api.innerspace.io/api/rest/oauth/token \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data 'client_id=Your%20Client%20ID&client_secret=Your%20Client%20Secret'

# Calling API
curl --request POST \
  --url https://api.innerspace.io \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <Access Token>' \
  --data '{"operationName":"sample_graphql","variables":{},"query":"query sample_graphql { BUILDING_INSIGHTS(where: {DATE_PARTITION: {_eq: 20250501}, BUILDING_ID: {_eq: 71}, GRANULARITY: {_eq: \"PT1H\"}, GROUP_ID: {_eq: \"all-e707b3a8-0732-49ae-9156-13ff1138540e\"}, SITE_ID: {_eq: 900000222}}, order_by: {DATE_TIME_START: desc}) { BUILDING_ID\n DATE_TIME_START\n OCCUPANCY_MEAN\n GRANULARITY\n GROUP_ID\n SITE_ID\n }\n }"'
Python GraphQL
import logging
import sys
from gql import gql, Client
from gql.transport.aiohttp import AIOHTTPTransport
from gql.transport.aiohttp import log as requests_logger
requests_logger.setLevel(logging.WARNING)


def main(argv):
    # Select your transport with a defined url endpoint, using the auth token from above
    transport = AIOHTTPTransport(url="https://api.innerspace.io/", headers={"Authorization": "Bearer {access_token}"})

    # Create a GraphQL client using the defined transport
    client = Client(transport=transport, fetch_schema_from_transport=True)

    # Execute the query on the transport
    query = """
 query sample_graphql {
  BUILDING_INSIGHTS(where: {DATE_PARTITION: {_eq: 20250501}, BUILDING_ID: {_eq: 71}, GRANULARITY: {_eq: "PT1H"}, GROUP_ID: {_eq: "all-e707b3a8-0732-49ae-9156-13ff1138540e"}, SITE_ID: {_eq: 900000222}}, order_by: {DATE_TIME_START: desc}) {
    BUILDING_ID
    DATE_TIME_START
    OCCUPANCY_MEAN
    GRANULARITY
    GROUP_ID
    SITE_ID
  }
}
        """
    print(client.execute(gql(query)))


if __name__ == "__main__":
    main(sys.argv)
Auth0 machine-to-machine (m2m) Client Credentials Flow