honeypot logo

Quickstart

This guide will get you all set up and ready to use the Honeypot API. We’ll cover how to get started and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful API.

Client

All Honeypot requests are made through HTTPS requests to the api.honeypot.is domain. All responses are returned as JSON objects. You can use any HTTP capable client to make requests to the API.

# cURL is most likely already installed on your machine
curl --version

Making your first API request

After you've gotten your API key, you can start making requests to the Honeypot API. Below, you can see how to send a GET request to the IsHoneypot endpoint to check if a token is a honeypot.

GET
/v2/IsHoneypot
curl -G https://api.honeypot.is/v2/IsHoneypot \
  -H "X-API-KEY: {APIKEY}" \
  -d address=0x0

What's next?

Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the Protocol API: