Lux API

Bring Lux technology to your website or application. Normal searching on Lux requires no API key. The developer API uses a Lux API key.

Get an API key

No Big-A account is required. Generate a key for your website or application and keep it available for your API requests.

No key generated yet.

Search API

GET /api/search?q=windows

Include your Lux API key with the request:

X-Big-A-Key: BA1.your-key-here

Website example

fetch('https://YOUR-BIG-A-DOMAIN/api/search?q=' + encodeURIComponent('windows'), {
  headers: {
    'X-Big-A-Key': 'BA1.your-key-here'
  }
})
.then(response => response.json())
.then(data => console.log(data));

Response

{
  "engine": "Lux",
  "query": "windows",
  "count": 2,
  "results": [
    {
      "title": "Example result",
      "url": "https://example.com/",
      "description": "Page description..."
    }
  ]
}

Limits

The optional limit parameter requests 1 to 50 results. More developer features can be added as the Lux API develops.