Introduction

All endpoints require API key authentication via the X-API-Key header. See the endpoint pages for full request/response details.

Base URL

https://api.bunny.build/api/v1

Authentication

Header	Required	Description
`X-API-Key`	Yes	Your API key (starts with `bun_`)
`Content-Type`	Conditional	`application/json` (required for POST requests)
`Accept`	Recommended	`application/json`

Example headers

X-API-Key: bun_aBcDeFgHiJkLmNoPqRsTuVwXyZ123456
Content-Type: application/json
Accept: application/json

Rate limiting

Responses include rate limit headers:

Header	Description
`X-RateLimit-Limit`	Requests per minute
`X-RateLimit-Remaining`	Remaining requests
`X-RateLimit-Reset`	Seconds until reset

On 429, the server may send Retry-After (seconds).

Error format

Errors return a JSON body:

{
  "detail": "Error message"
}

Validation errors (422) may return an array of detail objects with loc, msg, type.

HTTP status codes

Code	Meaning
200	Success
400	Bad Request: Invalid input
401	Unauthorized: Missing or invalid API key
402	Payment Required: Quota exceeded
403	Forbidden: Account deactivated
404	Not Found
422	Unprocessable Entity: Validation error
429	Too Many Requests: Rate limit exceeded
500	Internal Server Error

Endpoints

GET /cep-lookup/:cep

Look up a Brazilian postal code (CEP).

GET /cnpj-data/:cnpj

Fetch public data for a Brazilian company (CNPJ).

GET /currency-exchange

Get a real-time currency exchange rate.

GET /domain-availability/:domain

Check if a domain name is available.

GET /ip-classify

Classify an IP address by network type.

GET /ip-lookup

Look up geo and network data for an IP address.

GET /temporary-email

Check if an email uses a disposable domain.

POST /translate

Translate text between languages.

​ Base URL

​ Authentication

Example headers

​ Rate limiting

​ Error format

​ HTTP status codes

​ Endpoints

GET /cep-lookup/:cep

GET /cnpj-data/:cnpj

GET /currency-exchange

GET /domain-availability/:domain

GET /ip-classify

GET /ip-lookup

GET /temporary-email

POST /translate

Base URL

Authentication

Rate limiting

Error format

HTTP status codes

Endpoints