Module api

Interfacing with Ocean’s web API.

Modules

v1

Version 1 of Ocean’s web API.

Constants

DEFAULT_URL

The default URL to which API calls are made: https://api.oceanpkg.org/.

URL_ENV_KEY

The environment variable key for using an alternative API URL: OCEAN_API_URL.

Functions

url

Returns the parsed Url value for URL_ENV_VAR or DEFAULT_URL if it does not exist.

url_os_str

Returns the OS encoded value for URL_ENV_VAR or DEFAULT_URL if it does not exist.

url_str

Returns the UTF-8 encoded value for URL_ENV_VAR or DEFAULT_URL if it does not exist.