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 :ref:`API Key <startingout>` that will be used for authorization when performing API actions.

.. toctree::
   :maxdepth: 2
   
   EDX Homepage <https://edx.netl.doe.gov/>
   
.. toctree::
   :maxdepth: 2
   :caption: Getting Started
   
   whatIsAPI
   obtainingAPIKey

.. toctree::
   :maxdepth: 2
   :caption: Search APIs

   publicSearch 
   
.. toctree::
   :maxdepth: 2
   :caption: Data Resource APIs

   downloadResourceFiles
   obtainListFilesMetadataFolderID
   uploadResourceFiles   
   updatingExistingResourceFiles 
   download-stats 

.. toctree::
   :maxdepth: 2
   :caption: Folder APIs

   createFolderEDXDrive
   moveFolderEDXDrive
   editFolderEDXDrive
   deleteFolderEDXDrive

.. toctree::
   :maxdepth: 2
   :caption: Submission APIs

   public-submission 
   private-submission 
   finalize-submission
   submission-nominate 

.. toctree::
   :maxdepth: 2
   :caption: Workspace Lock

   lock-check 
   workspace-lock