StarloSearch API Reference

Welcome to the StarloSearch API Reference. Below, you'll find detailed information about the available API endpoints and how to use them.

Overview

StarloSearch API allows developers to integrate our search capabilities into their applications. This documentation provides all the necessary information to get started.

Authentication

All API requests require the use of an API key generated using Go's secure cryptographic features.

Generating an API Key

POST /api/v1/keys/generate

Make a POST request to this endpoint to generate a new API key.

Using Your API Key

Include your API key in the header of every API request:

Authorization: Bearer YOUR_API_KEY

Endpoints

Search

GET /api/v1/search?q={query}

Use this endpoint to perform a search query.

Results

GET /api/v1/search/results?id={search_id}

Retrieve the results for a specific search query.

Security

API keys are secured using Go's crypto package, ensuring SHA-256 hashing and constant-time comparison for robust security against timing attacks.

Error Handling

The API uses standard HTTP status codes to indicate the success or failure of an API request.

Rate Limiting

To ensure fair usage, the API enforces rate limiting. Exceeding the limit will result in a 429 error

Support

For now you can contact the creator mgamerdinge146@gmail.com because we don't have an official support mail or support team yet.

For access to the StarloSearch APIs, you'll need an API key, You can manage your API keys here.