API Reference
Welcome to the Roozna API reference. Our API provides programmatic access to Roozna's extensive database of business information, allowing you to integrate powerful business search and data enrichment capabilities into your applications.
Base URL
All API requests should be made to the following base URL:
## Authentication
The Roozna API uses API keys for authentication. You must include your API key in the `X-API-Key` header with every request.
Keep your API key secure and do not share it publicly. If you believe your API key has been compromised, you can regenerate it from your Roozna dashboard.
Request Format
The API accepts JSON-encoded request bodies and form-encoded data for POST and PUT requests. For GET requests, query parameters should be included in the URL.
Response Format
All responses are returned in JSON format. A typical successful response will have a structure similar to this:
{
"data": [
{
"id": "1234567890",
"name": "Example Business",
"description": "This is an example business.",
"category": "Technology",
"employeeCount": 100,
"website": "https://example.com"
}
],
"pagination": {
"total": 100,
"limit": 10,
"offset": 0,
}
}
Error Handling
In case of an error, the API will return an appropriate HTTP status code along with a JSON response body containing more details about the error. See our Error Handling guide for more information.
Rate Limiting
The API implements rate limiting to ensure fair usage. You can find your current rate limit status in the response headers of each API request. For more details, refer to our Rate Limiting guide.
Available Endpoints
Here's an overview of the main endpoints available in the Roozna API:
- Name
/search- Description
Search for businesses based on various criteria.
- Name
/businesses/:id- Description
Retrieve detailed information about a specific business.
- Name
/enrich- Description
Enrich your existing business data with additional information from our database.
Versioning
The current version of the API is v1. We strive to maintain backwards compatibility, but may occasionally need to make breaking changes. In such cases, we will provide ample notice and migration guides.
SDKs and Libraries
While you can use the API with any HTTP client, we offer official SDKs for several popular programming languages to make integration easier:
Need Help?
If you encounter any issues or have questions about using the API, please don't hesitate to contact our support team or visit our community forums.