Welcome to NETL’s Energy Data eXchange (EDX) API Documentation
EDX’s API supports public data searching and private data transfer within EDX collaborative workspaces.
To get started, you must first have an active EDX account and you must obtain your API Key that will be used for authorization when performing API actions.
Getting Started
Search APIs
Data Resource APIs
- Download Resource File(s)
- Obtain Resource Metadata from Folder ID
- Upload Resource Files
- Update Existing Resource File (Make Revision)
- Updating Revision Scenarios
- Resource Revision Update Clarifications
- EDX License Parameters
- Parameter Definitions
- Example 1: Resource Revision [File Only]
- Example 2: Resource Revision [Metadata Only]
- Example 3: Resource Revision [File Upload & Metadata Update]
- Example 4: Resource Revision [Chunked Revision Update]
- Get Resource Download Stats
Folder APIs
Submission APIs
- Create a Public Submission
- Parameter Definitions
- Author Parameter Definitions
- Example 1: Create a New Basic Public Submission with a Registered EDX User as Author
- Example 2: Create a New Basic Public Submission with Author who isn’t a Registered EDX User
- Example 3: Create a New Basic Public Submission with Multiple Authors (EDX user and non-EDX user)
- Example 4 : Create a New Public Submission with Additional NETL and Geospatial Fields
- Create a Private Submission
- Parameter Definitions
- Author Parameter Definitions
- Example 1: Create a New Basic Private Submission with a Registered EDX User as Author
- Example 2: Create a New Basic Private Submission with Author who isn’t a Registered EDX User
- Example 3: Create a New Basic Private Submission with Multiple Authors (EDX user and non-EDX user)
- Example 4 : Create a New Private Submission with Additional NETL and Geospatial Fields
- Finalize a Submission
- Nominate a Submission
Workspace Lock
Folder Tree
- Utilize Folder Trees for Workspaces
- Description
- Recursion Limits of Folder Trees
- Parameter Definitions
- Parameter Definitions for Folders and Sub-Folder in API Script Output
- Parameter Definitions for Resources in API Script Output
- Example 1: Create a Folder Tree from the Root Folder of a Workspace with Resources
- Example 2: Create a Folder Tree from the Root Folder of a Workspace without Resources
- Example 3: Create a Folder Tree from a Sub-Folder of a Workspace with Resources
- Example 4: Create a Folder Tree from a Sub-Folder of a Workspace without Resources
- Example 5: Recursion Limit Reached in a Folder Tree of a Workspace