Lotus home pagelight logo
  1. API Reference
  2. API Overview
GET

/api/ping/

X-API-KEY*
curl --request GET \
     --url https://api.uselotus.io/api/ping/ \
     --header 'X-API-KEY: AUTH_VALUE'

​
Getting Started

You can access Lotus’s API directly or through one of our SDKs. We highly recommend using the SDKs as they provide a more user-friendly interface and can help you more easily interpret the return types.

If you’re not using an SDK, all API calls must be made over https to api.uselotus.io/api/

​
How to use your API key

To obtain an API key, you must navigate to Settings > Developer Settings > API Keys in the Lotus frontend. You can create a new API key by clicking the Add API Key button, where you’ll be prompted to give it a name and an optional expiration date.

API Key Creation page

The full API key will only be shown once, so make sure to copy it somewhere safe. You can always delete or regenerate the API key if you need to.

The API key must be passed into the X-API-KEY header in your requests.

To confirm that your API key is working, you can make a request to the /api/ping endpoint. This will return the organization_id the API key belongs to.

lotus.ping()

​
Response

organization_idRequired
string