API Authentication

API Keys

To get started, you first need to Signup for an account and generate an API Key in your account's dashboard.

Once you have your key ready, you can start issuing requests to our servers using the X-API-KEY header with its value set to whatever is shown in your dashboard. It's that simple!

API Key security information

Your API Key represents your account. It is important that it always remains a secret and should therefore never be used in any front-end environment where it can be easily read or accessed.

If the API Key is somehow misplaced or leaked, make sure to immediately revoke and replace it by a new one.

Making a request

• The base URL for all our endpoints is: https://api.serpgrid.dev/{endpoint}

Below you'll find an example of what a request should look like together with its expected response. A response will typically include the following body fields:

• http_code HTTP integer status code
• http_message A message relevant to the status code
• timestamp Unix timestamp denoting when the request arrived
• execution_ms Integer containing number of milliseconds it took to execute the request
• message A message containing information about the execution outcome
• payload JSON object containing the response data (returns empty array if no data found)

Additionally, the following headers will also be returned for all relevant requests:

• X-Credits-Remaining The number of credits that remain in your account
• X-Credits-Expire A datetime string with the expiration date
• X-Credits-Used The number of credits the operation consumed

Example Request

// Example Request curl -L 'https://api.serpgrid.dev/{endpoint}' \ -H 'X-API-KEY: {API_KEY}' // Example Response Headers X-Credits-Remaining: 95768 X-Credits-Expire: 2025-07-17 11:32:30 X-Credits-Used: 5 // Example Response Body { "http_code": 200, "http_message": "Ok", "timestamp": 1752402209, "execution_ms": 250, "message": "Successful execution", "payload": { ... Response Data ... } }