Quickstart

This guide will get you all set up and ready to use the Signet API. We'll cover how to get started using one of our API clients 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 REST API.

Choose your client

Before making your first API request, you need to pick which API client you will use. Currently, our official SDKs for JavaScript, Python, and PHP are still under development. For now, we recommend using cURL or your preferred HTTP client to make requests to the Signet API. In the following example, you can see how to check if cURL is installed on your machine.

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

Making your first API request

After picking your preferred client, you are ready to make your first call to the Signet API. Below, you can see how to send a GET request to the Fraud endpoint to get a list of all your blacklisted users. In the cURL example, results are limited to 20 users, the default page length for each client.

GET
/fraud/v1
curl -X GET "http://api.getsignet.xyz/fraud/v1/blacklist/users" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE"

What's next?

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

Was this page helpful?