Introduction
The API allows sending URLs for indexing in our system through an API exposed at /api. This document explains how to use the API, the required parameters, and the expected responses.
API Endpoint
- URL:
https://honestindexer.com/api - Method:
POST - Data Format:
application/x-www-form-urlencoded
Authentication
The API uses an authentication key (API Key) to verify users. This key must be sent as part of the request data.
Required Parameters
| Parameter | Type | Description |
|---|---|---|
apikey | string | User’s API key. |
urls | string | List of URLs separated by | (vertical bar). |
Example cURL Request
curl -X POST https://honestindexer.com/api \
-d "apikey=YOUR_APIKEY" \
-d "urls=https://example.com|https://anotherwebsite.com"API Responses
Success
{
"success": true,
"inserted": 2,
"remaining_credits": 98
}Common Errors
| Code | Message | Cause |
|---|---|---|
| 400 | { “error”: “Missing parameters.” } | apikey or urls were not sent. |
| 403 | { “error”: “Invalid API key.” } | The API key is incorrect. |
| 403 | { “error”: “Insufficient credits.” } | There are not enough credits to index the URLs. |
| 400 | { “error”: “No valid URLs provided.” } | The submitted URLs are not valid. |
| 500 | { “error”: “Internal server error.” } | An internal issue prevented the operation. |
Additional Notes
- All URLs must start with
http://orhttps://. - If a URL contains special characters (such as
ñ), the system automatically converts it to Punycode.