Public Playground

Preview the endpoint before sending a live request

Sample responses, schemas, request previews, and code snippets are visible before sign in. Create an account when you are ready to save an API key and run authenticated requests.

Playground

Search Brave API Playground

Returns normalized web search results from Brave Search for a query string, along with offset-based pagination, related queries, discussions, videos, and the right-side knowledge.

GETapiKey3 credits/requestbrave.searchResponseDocBrave

Endpoint

Choose one catalog endpoint for this request.

1 shown
GETapiKey3 credits/requestbrave.searchResponseDocBrave
GET /brave/search

Search Brave

Returns normalized web search results from Brave Search for a query string, along with offset-based pagination, related queries, discussions, videos, and the right-side knowledge card when Brave includes one. Use time_range for preset ranges or date_from/date_to for a custom YYYY-MM-DD range. Locale defaults to country=us and lang=en-us.

API key required. Paste a full key or rotate one from the API Keys page.

Set up API key
View docs

API key

API key required for live requests. Your key is only used to send requests from this Playground.

not configured

Active Playground key: not configured

Manage API keys in Console

Required query parameters

Add an API key to send a live request.

If an active API key is configured, Copy cURL includes it. Share links never include API keys.

View docs
Sample responseGET

Shown before your first request. Add an API key and send a request to see the live response, status, latency, and headers.

{
  "code": 200,
  "msg": "OK",
  "data": {
    "results": [
      {
        "position": 1,
        "title": "OpenAI",
        "url": "https://openai.com/",
        "description": "OpenAI helps you build and deploy AI systems.",
        "hostname": "openai.com",
        "path": "research > overview"
      }
    ],
    "pagination": {
      "offset": 0,
      "next_offset": 1
    },
    "related_queries": [
      "openai api"
    ],
    "knowledge_card": {
      "title": "OpenAI",
      "description": "AI research and deployment company",
      "long_description": "OpenAI is an AI research and deployment company building useful models and tools.",
      "url": "https://openai.com/",
      "image": "https://imgs.search.brave.com/openai-card.png",
      "category": "Artificial intelligence company"
    },
    "discussions": [
      {
        "position": 1,
        "title": "Why is OpenAI so popular?",
        "url": "https://www.reddit.com/r/OpenAI/comments/abc123/why_is_openai_so_popular/",
        "description": "Trying to understand why OpenAI has such a large audience.",
        "forum": "r/OpenAI",
        "hostname": "www.reddit.com"
      }
    ],
    "videos": [
      {
        "position": 1,
        "title": "OpenAI DevDay keynote - YouTube",
        "url": "https://www.youtube.com/watch?v=openai-devday",
        "description": "Watch the OpenAI DevDay keynote and product announcements.",
        "platform": "YouTube",
        "creator": "OpenAI"
      }
    ]
  }
}

Endpoint details

Returns normalized web search results from Brave Search for a query string, along with offset-based pagination, related queries, discussions, videos, and the right-side knowledge card when Brave includes one. Use time_range for preset ranges or date_from/date_to for a custom YYYY-MM-DD range. Locale defaults to country=us and lang=en-us.

Method
GET
Path
/brave/search
Authentication
apiKey
Credit cost
3 credits/request
Platform
Brave
Parameters
8 documented fields

Request parameters

q:queryoffset:querycountry:querylang:querytime_range:querydate_from:querydate_to:queryx-api-key:header

Response schema fields

codedatadata.discussionsdata.discussions[].agedata.discussions[].comment_countdata.discussions[].descriptiondata.discussions[].favicondata.discussions[].forumdata.discussions[].hostnamedata.discussions[].pathdata.discussions[].positiondata.discussions[].score

Sample response summary

{
  "code": 200,
  "msg": "OK",
  "data": {
    "results": [
      {
        "position": 1,
        "title": "OpenAI",
        "url": "https://openai.com/",
        "description": "OpenAI helps you build and deploy AI systems.",
        "hostname": "openai.com",
        "path": "research > overview"
      }
    ],
    "pagination": {
      "offset": 0,
      "next_offset": 1
    },
    "related_queries": [
      "openai api"
    ],
    "knowledge_card": {
      "title": "OpenAI",
      "description": "AI research and deployment company",
      "long_description": "OpenAI is an AI research and deployment company building useful models and tools.",
      "url": "https://openai.com/",
      "image": "https://imgs.search.brave.com/openai-card.png",
      "category": "Artificial intelligence company"
    },
    "discussions": [
      {
        "position": 1,
        "title": "Why is OpenAI so popular?",
        "url": "https://www.reddit.com/r/OpenAI/comments/abc123/why_is_openai_so_popular/",
        "description": "Trying to understand why OpenAI has such a large audience.",
        "forum": "r/OpenAI",
        "hostname": "www.reddit.com"
      }
    ],
    "videos": [
      {
        "position": 1,
        "title": "OpenAI DevDay keynote - YouTube",
        "url": "https://www.youtube.com/watch?v=openai-devday",
        "description": "Watch the OpenAI DevDay keynote and product announcements.",
        "platform": "YouTube",
        "creator": "OpenAI"
      }
    ]
  }
}

cURL example

curl "https://api.crawlora.net/api/v1/brave/search?q=<q>" \
  -H "x-api-key: <api-key>"