ROAK SDK

User Guide

  • Getting Started with the ROAK SDK
    • What You Need
    • Installation
    • Setting Up Credentials
    • Connecting
    • Getting Well Data
    • Well Data Through a Site
    • Drilling Rig and Borehole Data
    • Modem-Only Access
    • Multi-Tenant Access
    • Handling Ambiguous Name Lookups
    • Common Errors
    • Where to Go Next

API Reference

  • Roak
    • Roak
      • Roak.refresh_tokens()
      • Roak.set_request_timeout()
      • Roak.get_asset_types()
      • Roak.get_customers()
      • Roak.get_customer_by_name()
      • Roak.get_customer_by_guid()
      • Roak.get_asset_by_guid()
      • Roak.get_asset_by_name()
      • Roak.get_wells()
      • Roak.get_boreholes()
      • Roak.get_project_by_name()
      • Roak.get_project_by_guid()
      • Roak.get_projects()
      • Roak.get_sites()
      • Roak.get_site_by_name()
      • Roak.get_site_by_guid()
      • Roak.get_borehole_by_guid()
      • Roak.get_well_by_guid()
      • Roak.get_well_by_name()
      • Roak.get_borehole_by_name()
      • Roak.get_rigs()
      • Roak.get_rig_by_name()
      • Roak.get_rig_by_guid()
      • Roak.get_modems()
      • Roak.get_modem_by_guid()
      • Roak.get_modem_by_name()
  • Project
    • Project
      • Project.get_assets()
      • Project.get_asset_by_guid()
      • Project.get_asset_by_name()
      • Project.get_sites()
      • Project.get_site_by_guid()
      • Project.get_site_by_name()
      • Project.get_wells()
      • Project.get_well_by_guid()
      • Project.get_well_by_name()
      • Project.get_boreholes()
      • Project.get_borehole_by_guid()
      • Project.get_borehole_by_name()
      • Project.get_attributes()
      • Project.get_last_values()
      • Project.refresh_attributes()
      • Project.guid
      • Project.name
  • Site
    • Site
      • Site.get_sites()
      • Site.get_asset_by_guid()
      • Site.get_asset_by_name()
      • Site.get_assets()
      • Site.get_attributes()
      • Site.get_borehole_by_guid()
      • Site.get_borehole_by_name()
      • Site.get_boreholes()
      • Site.get_last_values()
      • Site.get_site_by_guid()
      • Site.get_site_by_name()
      • Site.get_well_by_guid()
      • Site.get_well_by_name()
      • Site.get_wells()
      • Site.refresh_attributes()
      • Site.guid
      • Site.name
  • Well
    • Well
      • Well.DEFAULT_FEEDS
      • Well.DEFAULT_TIMEFRAME_DAYS
      • Well.get_attributes()
      • Well.get_data()
      • Well.get_feeds()
      • Well.get_last_values()
      • Well.refresh_attributes()
      • Well.guid
      • Well.name
  • Borehole
    • Borehole
      • Borehole.DEFAULT_FEEDS
      • Borehole.DEFAULT_TIMEFRAME_DAYS
      • Borehole.get_depth_data()
      • Borehole.get_attributes()
      • Borehole.get_data()
      • Borehole.get_feeds()
      • Borehole.get_last_values()
      • Borehole.refresh_attributes()
  • Rig
    • Rig
      • Rig.guid
      • Rig.name
      • Rig.DEFAULT_FEEDS
      • Rig.get_boreholes()
      • Rig.get_borehole_by_name()
      • Rig.get_borehole_by_guid()
      • Rig.DEFAULT_TIMEFRAME_DAYS
      • Rig.get_attributes()
      • Rig.get_children()
      • Rig.get_data()
      • Rig.get_feeds()
      • Rig.get_last_values()
      • Rig.refresh_attributes()
      • Rig.guid
      • Rig.name
  • Modem
    • Modem
      • Modem.DEFAULT_FEEDS
      • Modem.get_data_through_children()
      • Modem.DEFAULT_TIMEFRAME_DAYS
      • Modem.get_attributes()
      • Modem.get_children()
      • Modem.get_data()
      • Modem.get_feeds()
      • Modem.get_last_values()
      • Modem.refresh_attributes()
      • Modem.guid
      • Modem.name
  • Exceptions
    • RoakError
      • RoakError.add_note()
      • RoakError.args
      • RoakError.with_traceback()
    • AuthenticationError
      • AuthenticationError.add_note()
      • AuthenticationError.args
      • AuthenticationError.with_traceback()
    • MissingUsernameError
      • MissingUsernameError.add_note()
      • MissingUsernameError.args
      • MissingUsernameError.with_traceback()
    • MissingPasswordError
      • MissingPasswordError.add_note()
      • MissingPasswordError.args
      • MissingPasswordError.with_traceback()
    • MissingTokenError
      • MissingTokenError.add_note()
      • MissingTokenError.args
      • MissingTokenError.with_traceback()
    • MissingRefreshTokenError
      • MissingRefreshTokenError.add_note()
      • MissingRefreshTokenError.args
      • MissingRefreshTokenError.with_traceback()
    • InvalidJSONError
      • InvalidJSONError.add_note()
      • InvalidJSONError.args
      • InvalidJSONError.with_traceback()
    • TokenExpiredError
      • TokenExpiredError.add_note()
      • TokenExpiredError.args
      • TokenExpiredError.with_traceback()
ROAK SDK
  • ROAK SDK Documentation
  • View page source

ROAK SDK Documentation

The ROAK SDK provides a Python interface for interacting with the ROAK API. It covers projects, wells, boreholes, rigs, modems, and their associated data.

Current release status: Beta (v0.1.0).

User Guide

  • Getting Started with the ROAK SDK
    • What You Need
    • Installation
    • Setting Up Credentials
    • Connecting
    • Getting Well Data
    • Well Data Through a Site
    • Drilling Rig and Borehole Data
    • Modem-Only Access
    • Multi-Tenant Access
    • Handling Ambiguous Name Lookups
    • Common Errors
    • Where to Go Next

API Reference

  • Roak
    • Roak
  • Project
    • Project
  • Site
    • Site
  • Well
    • Well
  • Borehole
    • Borehole
  • Rig
    • Rig
  • Modem
    • Modem
  • Exceptions
    • RoakError
    • AuthenticationError
    • MissingUsernameError
    • MissingPasswordError
    • MissingTokenError
    • MissingRefreshTokenError
    • InvalidJSONError
    • TokenExpiredError
Next

© Copyright 2026, ROAK.

Built with Sphinx using a theme provided by Read the Docs.