API Documentation

Get started with our powerful search API in minutes

Quick Start

1. Get API Key

2. Make Request

Use your API key to make search requests

GET /search?keyword=query

3. Get Results

Receive structured JSON results instantly

{ results: [...] }

API Endpoints

GET

https://gateway.searchly.duysy-vincent.io.vn/search

Parameters

keyword(required)Search query string

Headers

X-API-Key(required)Your API key

Demo Search

GET

https://gateway.searchly.duysy-vincent.io.vn/demo/search

Parameters

keyword(required)Search query string

No API key required for demo purposes. Returns mock data.

Code Examples

Python

import requests

# Search with API key
url = https://gateway.searchly.duysy-vincent.io.vn/search
params = {"keyword": "python programming"}
headers = {"X-API-Key": "YOUR_API_KEY"}

response = requests.get(url, params=params, headers=headers)
data = response.json()

print(f"Found {data['result']['total_results']} results")
for result in data['result']['results']:
    print(f"- {result['title']}")

JavaScript

const response = await fetch('https://gateway.searchly.duysy-vincent.io.vn/search?keyword=javascript+tutorial', {
  headers: {
    'X-API-Key': 'YOUR_API_KEY'
  }
});

const data = await response.json();
console.log(`Found ${data.result.total_results} results`);

cURL

curl -X GET "https://gateway.searchly.duysy-vincent.io.vn/search?keyword=react+components" \
  -H "X-API-Key: YOUR_API_KEY"

Response Format

Success Response

{
  "task_id": "uuid-string",
  "result": {
    "query": "search query",
    "results": [
      {
        "title": "Result Title",
        "url": "https://example.com",
        "content": "Result description...",
      }
    ],
    "total_results": 3,
    "search_time": "500ms"
  }
}

Error Codes

400

Bad Request

Invalid parameters or missing required fields

403

Forbidden

Invalid or inactive API key

429

Too Many Requests

Rate limit exceeded or quota exceeded

504

Gateway Timeout

Search request timed out