Interacting with OSDU
There are several ways to interact with the OSDU platform. Choose the one that fits your workflow.
A command-line tool for interactive exploration, quick queries, and admin tasks.
Installation (Windows)
1. Install Python 3.13 from Python for Windows. Download the 64-bit installer, run it, and check "Add Python 3.13 to PATH".
2. Set up a virtual environment:
python -m venv .venv
Activate it:
- Command Prompt:
.venv\Scripts\activate - Git Bash/PowerShell:
source .venv/Scripts/activate
Your terminal prompt should now start with (.venv).
3. Install the OSDU CLI:
python -m pip install --upgrade pip
python -m pip install osducli
Verify it works: osdu -h
4. Configure your environment by following How to Connect to a Specific Environment.
CLI command overview
osdu <command> [options]
| Category | Description |
|---|---|
config |
Configuration management |
crs |
Coordinate Reference System commands |
dataload |
Data loading operations |
entitlements |
Entitlement service commands |
file |
File service commands |
legal |
Legal service commands |
list |
Listing information |
schema |
Schema management |
search |
Search services |
status |
Service status checks |
storage |
Storage service commands |
unit |
Unit management |
version |
Version information |
workflow |
Workflow management |
For help with any command: osdu <command> -h
Troubleshooting
Installation blocked by administrator — Go to Virus & threat protection settings, add an exclusion for the osdu-operations folder, and retry.
'pip', 'osdu', or 'python' not recognized — Add these to your system PATH:
C:\Users\<YourUsername>\AppData\Local\Programs\Python\Python313\C:\Users\<YourUsername>\AppData\Local\Programs\Python\Python313\Scripts\
Then restart your terminal and verify with python --version.
A Python library for scripts, notebooks, and lightweight automation.
pip install osdu-sdk
from osdu.client import OsduClient
from osdu.identity import OsduMsalInteractiveCredential
server = "https://equinorswedev.energy.azure.com"
data_partition = "dev"
credential = OsduMsalInteractiveCredential(client_id, authority, resource_id)
client = OsduClient(server, data_partition, credential)
response = client.get(f"{server}/api/search/v2/health/readiness_check")
For full connection details and non-interactive authentication, see How to Connect to a Specific Environment. For more examples, see the Python SDK repository.
Full control from any language or tool. Acquire a token from Microsoft Entra ID and include it in your requests.
curl -X GET "https://equinorswedev.energy.azure.com/api/search/v2/health/readiness_check" \
-H "Authorization: Bearer <token>" \
-H "data-partition-id: dev"
See ADME Technical Reference for the full list of service endpoints and API paths.
OPUS is a tool built by the SMDA team for viewing and exploring well data stored in OSDU. If you work with wells, wellbores, or well logs, OPUS provides a visual interface for browsing this data without writing code or queries.