Skip to main content

Account Management

To use the Geodesic API you must first authenticate your account with our the platform. This can be done either from Python or from the command line.

CLI Authentication​

geodesic authenticate

returns:

geodesic authenticate

To authorize access needed by Geodesic, open the following URL in a web browser and follow the instructions.

If the web browser does not start automatically, please manually browse the URL below.

A browser window should open and you will see the following screen.

{
"api_key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}

if you have already authenticated, you will see:

Authentication successful!
Credentials have been retrieved. Please close this window.

Python Authentication​

Python authentication can be done either in the python interpreter or a Jupyter environment.

import geodesic
geodesic.authenticate()
note

You will not need to log in each time you use the API. The credentials stored are long lived. If you are worried that you may have copied the key incorrectly you can check the stored credentials in ~/.config/geodesic/config.json file.