# ourskyai-sda-api
The basic flow for a new organization is as follows:
1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/GET/v1/satellite-targets) endpoint. Copy the id of the target you want to observe.
2. Create an organization target with the [organization target](#tag/organization-targets/GET/v1/organization-targets) endpoint. Use the id copied from above.
3. Create a webhook with the [webhook](#tag/webhooks/POST/v1/communications/webhook) endpoint to receive OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs.
Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.3.8639
- Package version: 1.3.8639
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
```sh
pip install ourskyai_sda_api
```
(you may need to run `pip` with root permission: `sudo pip install ourskyai_sda_api`)
### Poetry install
If you manage dependencies with [poetry](https://python-poetry.org/) then you can add the SDK with:
```sh
poetry add ourskyai_sda_api
```
### Import the package
Then import the package:
```python
import ourskyai_sda_api
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import os
import ourskyai_sda_api
from ourskyai_sda_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.prod.oursky.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = ourskyai_sda_api.Configuration(
host = "https://api.prod.oursky.ai"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization: BearerToken
configuration = ourskyai_sda_api.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with ourskyai_sda_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ourskyai_sda_api.DefaultApi(api_client)
after = '2013-10-20T19:20:30+01:00' # datetime | The timestamp to get the next page of results. Defaults to the 1 day prior to the current UTC time. (optional)
try:
# Get uncorrelated tracks collected by the network.
api_response = api_instance.get_uncorrelated_tracks(after=after)
print("The response of DefaultApi->get_uncorrelated_tracks:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->get_uncorrelated_tracks: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://api.prod.oursky.ai/docs/sda*
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="BearerToken"></a>
### BearerToken
- **Type**: Bearer authentication
<a id="Roles"></a>
### Roles
## Author
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "ourskyai_sda_api",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, OurSky SDA",
"author": "OpenAPI Generator Community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/88/ed/af5cc996ceb72252d0d0f8a975882f09011fb155bed48416f482b13d6c8b/ourskyai_sda_api-1.3.8639.tar.gz",
"platform": null,
"description": "# ourskyai-sda-api\nThe basic flow for a new organization is as follows:\n1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/GET/v1/satellite-targets) endpoint. Copy the id of the target you want to observe.\n2. Create an organization target with the [organization target](#tag/organization-targets/GET/v1/organization-targets) endpoint. Use the id copied from above.\n3. Create a webhook with the [webhook](#tag/webhooks/POST/v1/communications/webhook) endpoint to receive OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs.\n\nCheck out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.3.8639\n- Package version: 1.3.8639\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\n```sh\npip install ourskyai_sda_api\n```\n(you may need to run `pip` with root permission: `sudo pip install ourskyai_sda_api`)\n\n### Poetry install\nIf you manage dependencies with [poetry](https://python-poetry.org/) then you can add the SDK with:\n\n```sh\npoetry add ourskyai_sda_api\n```\n\n### Import the package\n\nThen import the package:\n```python\nimport ourskyai_sda_api\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport os\nimport ourskyai_sda_api\nfrom ourskyai_sda_api.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://api.prod.oursky.ai\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = ourskyai_sda_api.Configuration(\n host = \"https://api.prod.oursky.ai\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure Bearer authorization: BearerToken\nconfiguration = ourskyai_sda_api.Configuration(\n access_token = os.environ[\"BEARER_TOKEN\"]\n)\n\n\n# Enter a context with an instance of the API client\nwith ourskyai_sda_api.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = ourskyai_sda_api.DefaultApi(api_client)\n after = '2013-10-20T19:20:30+01:00' # datetime | The timestamp to get the next page of results. Defaults to the 1 day prior to the current UTC time. (optional)\n\n try:\n # Get uncorrelated tracks collected by the network.\n api_response = api_instance.get_uncorrelated_tracks(after=after)\n print(\"The response of DefaultApi->get_uncorrelated_tracks:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling DefaultApi->get_uncorrelated_tracks: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.prod.oursky.ai/docs/sda*\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"BearerToken\"></a>\n### BearerToken\n\n- **Type**: Bearer authentication\n\n<a id=\"Roles\"></a>\n### Roles\n\n\n\n## Author\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "OurSky SDA",
"version": "1.3.8639",
"project_urls": {
"Homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
" openapi-generator",
" oursky sda"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "caf7c6b96efacb8b75085c45514997d3d1121a9e3ae3cec14004498f23ed7be8",
"md5": "4a4da27d24890cdc478753094d21eda5",
"sha256": "736fff6f34a1cffa083882240dae7160bdf056fc64d6bd97ffcfa016cfe5e969"
},
"downloads": -1,
"filename": "ourskyai_sda_api-1.3.8639-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4a4da27d24890cdc478753094d21eda5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 147592,
"upload_time": "2025-10-23T05:36:35",
"upload_time_iso_8601": "2025-10-23T05:36:35.043829Z",
"url": "https://files.pythonhosted.org/packages/ca/f7/c6b96efacb8b75085c45514997d3d1121a9e3ae3cec14004498f23ed7be8/ourskyai_sda_api-1.3.8639-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "88edaf5cc996ceb72252d0d0f8a975882f09011fb155bed48416f482b13d6c8b",
"md5": "e838ca5a78ad6818b663e5b53d006957",
"sha256": "fa71b401a00e6eb70610a6743e7d14a0c7e3ff528f526485fa9672b6d7653ae0"
},
"downloads": -1,
"filename": "ourskyai_sda_api-1.3.8639.tar.gz",
"has_sig": false,
"md5_digest": "e838ca5a78ad6818b663e5b53d006957",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 75351,
"upload_time": "2025-10-23T05:36:37",
"upload_time_iso_8601": "2025-10-23T05:36:37.478287Z",
"url": "https://files.pythonhosted.org/packages/88/ed/af5cc996ceb72252d0d0f8a975882f09011fb155bed48416f482b13d6c8b/ourskyai_sda_api-1.3.8639.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-23 05:36:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "ourskyai_sda_api"
}
JSON
