Quickstart

Get up and running with Serply API in just a few minutes.

Production Endpoint

All API requests should be made to:

https://api.serply.io

Making Your First API Request

An API key is a token that you provide when making API calls. Include the token in a header parameter called X-Api-Key.

Using cURL

curl --header 'X-Api-Key: YOUR_API_KEY' \
  'https://api.serply.io/v1/search/q=google+search+api'

Using JavaScript/Node.js

const response = await fetch('https://api.serply.io/v1/search/q=google+search+api', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY'
  }
});
const data = await response.json();
console.log(data);

Using Python

import requests
from urllib.parse import quote_plus

query = quote_plus('google search api')

response = requests.get(
    f'https://api.serply.io/v1/search/q={query}',
    headers={'X-Api-Key': 'YOUR_API_KEY'}
)
data = response.json()
print(data)

Note the /q=, not ?q=. Search endpoints take the query packed into the path, which is why the examples above have no ?. The ?q= spelling is also accepted and returns the same results, so either will work - but /q= is the canonical form and the one every example here uses. Google Maps is the exception that genuinely uses ?: it takes a path-packed query followed by ?num=&hl=&gl=. See the Google Maps reference.

Getting Your API Key

  1. Sign up at app.serply.io
  2. Navigate to your dashboard
  3. Copy your API key from the settings page

You can view and manage your API keys in the Dashboard.

What's Next?

View as Markdown