Introduction

Welcome to the IPSwamp API documentation. This API provides threat intelligence and IP reputation services.

Base URL

https://ipswamp.com/api/v1

Quick Start

1. Obtain an API Key from your IPSwamp dashboard
2. Authenticate your requests using Bearer token or API key header
3. Make requests to the available endpoints

Available Endpoints

v1 API

Endpoint	Method	Description
/account	GET	Retrieve API key and organization quota details
/test-key	GET	Validate API key and check usage
/checkIP	GET	Check IP address threat intelligence
/checkIP/bulk	POST	Look up multiple IPs in a single request
/checkSubnet	GET	Scan a CIDR subnet range for threats
/export	GET	Export threat data as CSV or JSON

Public Endpoints

Endpoint	Method	Description
/public/badge	GET	SVG reputation badge (no auth required)

Rate Limiting

Usage limits are applied based on your subscription tier:

Tier	Limit
Public	20 requests per hour
Free API Key	1,000 requests per day
Paid Plans	Custom limits by tier

• Usage resets according to your billing cycle
• Priority: Partner Status > Active Subscription > Unlimited

WARNING

Each successful API call (2xx) or client error (4xx, except 404) increments your usage counter. For bulk and subnet endpoints, only IPs found in the database count toward quota.

INFO

The /account endpoint can be used to inspect current quota usage. In the documented response example, it does not count toward quota.

Response Format

All responses are returned in JSON format with appropriate HTTP status codes.

Common Status Codes

Status	Meaning
200	Success
400	Bad Request - Invalid parameters
401	Unauthorized - API key required
403	Forbidden - Invalid or expired API key
500	Internal Server Error

Support

For API support and questions, please contact our support team or visit the IPSwamp dashboard.