sensorpush-api

This is a swagger definition for the SensorPush public REST API. Download the definition file here.

This Python package is automatically generated by the OpenAPI Generator project:

API version: v1.0.20240803
Package version: 2.1.3
Generator version: 7.8.0
Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import sensorpush_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import sensorpush_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import sensorpush_api
from sensorpush_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.sensorpush.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = sensorpush_api.Configuration(
    host = "https://api.sensorpush.com/api/v1"
)



# Enter a context with an instance of the API client
async with sensorpush_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sensorpush_api.ApiApi(api_client)
    access_token_request = sensorpush_api.AccessTokenRequest() # AccessTokenRequest | 

    try:
        # Request a temporary oAuth access code.
        api_response = await api_instance.access_token(access_token_request)
        print("The response of ApiApi->access_token:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ApiApi->access_token: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.sensorpush.com/api/v1

Class	Method	HTTP request	Description
ApiApi	access_token	POST /oauth/accesstoken	Request a temporary oAuth access code.
ApiApi	download	POST /reports/download	Download bulk reports.
ApiApi	gateways	POST /devices/gateways	Lists all gateways.
ApiApi	list	POST /reports/list	Lists reports available for download.
ApiApi	oauth_authorize_post	POST /oauth/authorize	Sign in and request an authorization code
ApiApi	root_post	POST /	SensorPush API status
ApiApi	samples	POST /samples	Queries for sensor samples.
ApiApi	sensors	POST /devices/sensors	Lists all sensors.
ApiApi	tags_response	POST /tags	Updates tags on devices.
ApiApi	token	POST /oauth/token	oAuth 2.0 for authorization, access, and refresh tokens

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

oauth

Type: API key
API key parameter name: Authorization
Location: HTTP header

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sensorpush_api-2.1.3.tar.gz (35.3 kB view details)

Uploaded Jun 10, 2025 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

sensorpush_api-2.1.3-py3-none-any.whl (79.8 kB view details)

Uploaded Jun 10, 2025 Python 3

File details

Details for the file sensorpush_api-2.1.3.tar.gz.

File metadata

Download URL: sensorpush_api-2.1.3.tar.gz
Upload date: Jun 10, 2025
Size: 35.3 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sensorpush_api-2.1.3.tar.gz
Algorithm	Hash digest
SHA256	`ffbf78accd693ddf9df7a2ad503ce8739ad098ac5c83939ee8f2f1391c4e853b`
MD5	`fbd22b6db88f94534ff440163f9ca908`
BLAKE2b-256	`2898942d2ca3860e725289d88ad83371c8aed6885f5eecfaf49a9242286637b6`

See more details on using hashes here.

Provenance

The following attestation bundles were made for sensorpush_api-2.1.3.tar.gz:

Publisher: release.yml on sstallion/sensorpush-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: sensorpush_api-2.1.3.tar.gz
- Subject digest: ffbf78accd693ddf9df7a2ad503ce8739ad098ac5c83939ee8f2f1391c4e853b
- Sigstore transparency entry: 234495536
- Sigstore integration time: Jun 10, 2025
Source repository:
- Permalink: sstallion/sensorpush-api@837307a9bfb84213e441a4a1fee5eaa0e2a47268
- Branch / Tag: refs/tags/v2.1.3
- Owner: https://github.com/sstallion
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@837307a9bfb84213e441a4a1fee5eaa0e2a47268
- Trigger Event: push