Changelog

Changelog

Keep track of changes to the POAP API

Suggest Edits

July 28, 2023 Update date

Error copy is being updated to be more human readable and user friendly. This applies to the following endpoints:
/website/claim
/secret/:secret_word
No action is required from Integrators

June 06, 2023

We are implementing two main changes:

The implementation on your end should be pretty straightforward, requiring only two modifications in order to continue using POAP API.

For example, retrieving auth token:
curl --location --request POST --url 'https://auth.accounts.poap.xyz' --header "Content-Type: application/json" -d '{"audience": "https://api.poap.tech", "grant_type": "client_credentials", "client_id": "$clientid", "client_secret": "$clientsecret"}'

April 20, 2023

For large collections of POAPs, it may take a while to load the artwork, since average size of the original artwork can be ~2MB per item (we allow upto 4MB). For solving this, we've developed a way to offer compressed artwork. To use this, you can request a smaller, lower resolution version of the image, simply append "?size=small" to the end of the URL. For example, https://poap.xyz/image.png?size=small

You may do this using /actions/scan/{address}/{eventId} or /actions/scan/{address} endpoint.

December 20, 2022

Following fields city, country, or event_url when creating an event will no longer accept strings filled with only spaces e.g. " "
They will continue to accept empty strings e.g."" , or strings with contents, or fields can be null where applicable.

November 25, 2022

Deprecating .xyz url

Earlier this year, we communicated migration to api.poap.tech base URL, and as a result, we are now deprecating the older base url api.poap.xyz on Nov 25, 2022. If you are already using api.poap.tech this change will not impact you.
If you aren't already, the implementation on your end should be pretty straightforward. Only two modifications are needed in order to use the newer version of our API.

Changing the base URL on all API calls from api.poap.xyz to api.poap.tech

All requests should now include an additional header

  • Requests hould now contain the header X-API-Key={apikey}, where {apikey} is your unique API key attached below: secretlink password: {pass}
  • Your API key is unique and static, so please store it safely. If your API key is compromised, we can provide a replacement
  • For example, a header with the new API key would look like this: curl -vvv -H "X-API-Key: myapikey" https://api.poap.tech/paginated-events?limit=100&offset=0&sort_dir=asc&sort_field=name
  • If you don't already have an API key, request here

November 18, 2022

Captcha as a parameter is removed from PUT /secret-requests. And as a result, Captcha is also removed from GET /secret/{secret_word} effective Nov 18.

October 18, 2022

  • We now require True , False for virtual_event when using POST /events

August 22, 2022

  • We will be performing system maintenance between 8pm - 9pm UTC. No downtime is planned, although there may be momentary service interruptions.

August 12, 2022

  • The start_date , end_date , expiry_date parameters for POST /events and PUT /events/{fancyId} have been updated to require YYYY-MM-DD or MM-DD-YYYY format.

August 03, 2022

  • The description parameter for POST /events and PUT /events/{fancyId} has been updated to have a 1500 character limit.

June 30, 2022

  • The GET /events will soon be deprecated. If you are using this endpoint, you migrate to using GET /paginated-events.

April 20, 2022

  • We are introducing API keys (beta), please reach out to get a copy.

April 13, 2022

  • Changed the base URL on all API calls to api.poap.tech. All endpoints will still use their current name, method, body, and parameters under the new base URL. We just moved them under a new domain name and added a layer of security.

Updated about 2 months ago