Documentation 3 min read

Introduction

Welcome to the Chapybara API – your all-in-one platform for domain, IP, web technology, and screenshot intelligence. Chapybara provides powerful, real-time APIs for security analysis, geolocation, threat detection, web stack discovery, and more.


🚀 Quick Start

Get started in minutes:

  1. Sign up for a free account to get your API key.
  2. Explore the API Playground to make live requests.
  3. Use the examples below to integrate into your application.

Example: Get Domain Intelligence

curl -X GET "https://api.chapyapi.com/api/v1/domain/google.com" \
  -H "X-API-Key: your_api_key_here"

📚 API Reference

Our API is organized into four main endpoints. Each is designed for a specific intelligence need.

API Description Docs Link
IP IP geolocation, ASN, proxy/VPN/Tor, risk IP API Docs
Domain Domain intelligence, DNS, SSL, threats, subdomains Domain API Docs
Web Tech Web stack, headers, meta, structure, versions Web Tech API Docs
Screenshot Full-page desktop and mobile screenshots Screenshot API Docs

🔑 Authentication

All production endpoints require an API key. Pass your key in the X-API-Key header (recommended) or as a ?api_key= query parameter.

X-API-Key: your_api_key_here

API Key Management

You can create, manage, and revoke API keys from your API Keys Dashboard. It is recommended to use separate keys for different environments (development, production) and applications.


⏱️ Rate Limits & Quotas

All users are subject to standard rate limits and daily usage quotas to ensure service stability for everyone.

  • Rate Limits: Control the number of requests per minute.
  • Quotas: Control the total number of requests per day. Quotas reset daily at 00:00 UTC.

Rate limit status is included in every API response header:

  • X-RateLimit-Limit: The maximum number of requests allowed in the current window.
  • X-RateLimit-Remaining: The number of requests remaining in the current window.
  • X-RateLimit-Reset: The Unix timestamp when the rate limit window resets.

Exceeding your rate limit or quota will result in an HTTP 429 Too Many Requests error.


Versioning & Changelog

API Versioning

The current stable version of the API is v1. All endpoints are prefixed with /api/v1/.

Breaking changes will be introduced under a new version (e.g., /api/v2/). We will provide at least 90 days' notice before deprecating an old version. Non-breaking changes (e.g., adding new fields to a response) may be added to the current version without notice.


💡 Support & Status


⚖️ Legal & Attribution


Ready to get started? Sign up for a free account!