Quickstart
This guide will get you all set up and ready to use the ipbase 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.
Before you can make requests to the ipbase API, you will need to grab your API key from your dashboard. You find it under App » Dashboard.
Choose your client
Before making your first API request, you need to pick which API client you will use. In addition to cURL HTTP requests, ipbase offers clients for JavaScript, Python, PHP and many more programming langauges. In the following example, you can see how to install each client.
# 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 ipbase API. Below, you can see how to send a
GET
request to the /info
endpoint to get information about your client's IP address.
curl -G https://api.ipbase.com/v2/info \
-H "apikey: YOUR-API-KEY"
Alternatively, you can retrieve information about any specific IP address:
curl -G https://api.ipbase.com/v2/info?ip=1.1.1.1 \
-H "apikey: YOUR-API-KEY"
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 ipbase API: