em-toolhub

REST API for customer access to ToolHub well data.

Upgrading to 0.6.0

A run's bha_components can now hold a pulser entry as well as an rss one. The em-toolhub Python client 0.5.x and older refuses a run that has a pulser entry, and so a list of runs that contains one, so upgrade it to 0.6.0 or later.

Authentication

All endpoints require Bearer token authentication using an API key:

Authorization: Bearer thub_live_xxxxxxxxxxxxxxxxxxxx

API keys are issued per-organization and inherit well access permissions.

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

API version: 0.7.0
Package version: 0.7.0
Generator version: 7.19.0
Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://erdosmiller.com

Requirements.

Python 3.9+

Installation & Usage

pip install

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

pip install git+https://github.com/Erdos-Miller/repo.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/Erdos-Miller/repo.git)

Then import the package:

import em_toolhub

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 em_toolhub

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import em_toolhub
from em_toolhub.rest import ApiException
from pprint import pprint

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

# 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 (API Key): bearerAuth
configuration = em_toolhub.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with em_toolhub.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = em_toolhub.ContinuousMeasurementsApi(api_client)
    well_id = 'well_id_example' # str | 
    updated_since = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    cursor = 'cursor_example' # str |  (optional)
    limit = '100' # str |  (optional) (default to '100')
    wellbore_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |  (optional)

    try:
        # List continuous measurements for a well
        api_response = api_instance.list_continuous_measurements(well_id, updated_since=updated_since, cursor=cursor, limit=limit, wellbore_id=wellbore_id)
        print("The response of ContinuousMeasurementsApi->list_continuous_measurements:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ContinuousMeasurementsApi->list_continuous_measurements: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.erdosmiller.com

Class	Method	HTTP request	Description
ContinuousMeasurementsApi	list_continuous_measurements	GET /api/v1/wells/{wellId}/continuous-measurements	List continuous measurements for a well
CorrectionsApi	get_survey_corrections	GET /api/v1/wells/{wellId}/surveys/{surveyId}/corrections	List corrections for a survey
CorrectionsApi	list_trajectory_points	GET /api/v1/wells/{wellId}/wellbores/{wellboreId}/trajectory-points	List your trajectory points
CorrectionsApi	list_well_corrections	GET /api/v1/wells/{wellId}/corrections	List survey corrections for a well
CorrectionsApi	replace_trajectory_points	PUT /api/v1/wells/{wellId}/wellbores/{wellboreId}/trajectory-points	Replace your trajectory points
CorrectionsApi	write_survey_correction	POST /api/v1/wells/{wellId}/surveys/{surveyId}/corrections	Submit a survey correction
DecodesApi	list_decodes	GET /api/v1/wells/{wellId}/decodes	List decoded measurement samples for a well
EventsApi	list_events	GET /api/v1/events	Replay webhook events
FilesApi	delete_file	DELETE /api/v1/wells/{wellId}/files/{fileId}	Archive file
FilesApi	download_file	GET /api/v1/wells/{wellId}/files/{fileId}/download	Download file
FilesApi	finalize_file_upload	POST /api/v1/wells/{wellId}/files/uploads/{uploadId}/finalize	Finalize a direct well-file upload
FilesApi	get_file	GET /api/v1/wells/{wellId}/files/{fileId}	Get file details
FilesApi	get_file_upload_status	GET /api/v1/wells/{wellId}/files/uploads/{uploadId}	Get file upload status
FilesApi	list_files	GET /api/v1/wells/{wellId}/files	List files
FilesApi	prepare_file_upload	POST /api/v1/wells/{wellId}/files/uploads	Prepare a direct well-file upload
FilesApi	retry_file_pressure	POST /api/v1/wells/{wellId}/files/{fileId}/pressure/retry	Retry pressure processing for an existing file
FilesApi	update_file_run	PATCH /api/v1/wells/{wellId}/files/{fileId}	Conditionally update a file run
RigsApi	create_rig	POST /api/v1/rigs	Create a rig
RigsApi	get_rig	GET /api/v1/rigs/{rigId}	Get a rig
RigsApi	list_rigs	GET /api/v1/rigs	List rigs
RunsApi	create_run	POST /api/v1/wells/{wellId}/runs	Create a run
RunsApi	get_run	GET /api/v1/wells/{wellId}/runs/{runId}	Get current run state
RunsApi	list_runs	GET /api/v1/wells/{wellId}/runs	List current runs
RunsApi	update_run	PATCH /api/v1/wells/{wellId}/runs/{runId}	Update current run state
SurveysApi	create_survey	POST /api/v1/wells/{wellId}/surveys	Create survey
SurveysApi	delete_survey	DELETE /api/v1/wells/{wellId}/surveys/{surveyId}	Delete survey
SurveysApi	get_survey	GET /api/v1/wells/{wellId}/surveys/{surveyId}	Get survey details
SurveysApi	list_surveys	GET /api/v1/wells/{wellId}/surveys	List surveys for a well
SurveysApi	update_survey	PATCH /api/v1/wells/{wellId}/surveys/{surveyId}	Update survey MD or status
WITSApi	list_latest_wits_values	GET /api/v1/wells/{wellId}/wits/latest	Get the latest WITS value for each item on a well
WITSApi	list_wits_values	GET /api/v1/wells/{wellId}/wits	List WITS Level 0 values for a well
WellboresApi	create_wellbore	POST /api/v1/wells/{wellId}/wellbores	Create wellbore
WellboresApi	delete_wellbore	DELETE /api/v1/wells/{wellId}/wellbores/{wellboreId}	Delete wellbore
WellboresApi	get_wellbore	GET /api/v1/wells/{wellId}/wellbores/{wellboreId}	Get wellbore
WellboresApi	get_wellbore_tree	GET /api/v1/wells/{wellId}/wellbores/tree	Get wellbore tree
WellboresApi	list_wellbores	GET /api/v1/wells/{wellId}/wellbores	List wellbores
WellboresApi	update_wellbore	PUT /api/v1/wells/{wellId}/wellbores/{wellboreId}	Update wellbore
WellsApi	create_well	POST /api/v1/wells	Create a well
WellsApi	delete_well_external_id	DELETE /api/v1/wells/{wellId}/external-id	Clear your external ID for a well
WellsApi	get_well	GET /api/v1/wells/{wellId}	Get well details
WellsApi	get_well_external_id	GET /api/v1/wells/{wellId}/external-id	Get your external ID for a well
WellsApi	list_wells	GET /api/v1/wells	List wells
WellsApi	put_well_external_id	PUT /api/v1/wells/{wellId}/external-id	Set your external ID for a well
WellsApi	update_well	PATCH /api/v1/wells/{wellId}	Update well metadata

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

Type: Bearer authentication (API Key)

Author

Metadata

Release files for em-toolhub 0.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for em-toolhub 0.7.0
File	Size	Uploaded	Provenance
em_toolhub-0.7.0.tar.gz	187.3 kB	Oct 23, 2026	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for em-toolhub 0.7.0
File	Interpreter	ABI	Platform	Reset
em_toolhub-0.7.0-py3-none-any.whl 673.4 kB Oct 23, 2026 Without provenance	Python 3	none	any	Details

Total release size: 860.7 kB

Release files / em_toolhub-0.7.0.tar.gz

Download URL	em_toolhub-0.7.0.tar.gz
Size	187.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`4a556ef5d097950712883c578aa63d8b53c49cb24697b4c7cf3de1456ac1375d`
BLAKE2b-256 checksum How to use checksums	`2add1d25ae2e662d0454d2f9912c8c4fc77bdec7067124857011254f23f9ea53`
Upload date	Oct 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.3`

Release files / em_toolhub-0.7.0-py3-none-any.whl

Download URL	em_toolhub-0.7.0-py3-none-any.whl
Size	673.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`bc5d62c29f75c9a16b32e084118078dc7ced8de283eb2d977812768d6ff5e14d`
BLAKE2b-256 checksum How to use checksums	`2de864a2a5478de7d9ae706c786182d09548a99af6aa7691afab84c15805066b`
Upload date	Oct 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.3`

Security for em-toolhub 0.7.0

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.