<aside> ⚠️

These APIs are in limited beta stage.

Please don’t share this widely since the documented APIs might have breaking changes.

</aside>



Pagination

Paginated endpoints return a next.cursor property next to the result object. To fetch the next page, send the value as a cursor query parameter. An optional limit query parameter can be used to specify the page size.

{
  "result": {
    ...
  },
  "next": {
    "cursor": "eyJwYWdlIjoxLCJsaW1pdCI6MTAwfQ"
  }
}

Authentication

Developers can generate an API key for programmable DCs at https://warpcast.com/~/developers/api-keys.

Screenshot 2024-05-09 at 12.27.07 PM.png

Click “Create an API Key” to generate a new key, and enter a description and expiration date. Default expiration is 1 year from creation time.

Screenshot 2024-05-09 at 12.31.25 PM.png

Your key will only be shown once, so make sure you copy it and save it somewhere secure. Developers should treat this key as a secret and manage it appropriately. Clicking “Copy API Key” in the dialog below will automatically copy your key to the clipboard.

Screenshot 2024-05-09 at 12.31.43 PM.png

You can create and revoke keys from the developer dashboard. There is a soft limit of 50 API keys per user.