Firecrawl

Firecrawl Search

post

Header parameters

AuthorizationstringRequiredExample: sk-sGQ5aAbuC3JDaOF3sHXKTCnu1pNHFYg7MuefP90c56BudF2g

Body

application/json

modelstringRequiredExample: firecrawl-search

querystringRequiredExample: who is Leo Messi?

limitinteger · min: 1 · max: 100Optional

Maximum number of results to return

Default: 5Example: 5

tbsstringOptional

Time-based search parameter. Supports predefined time ranges (qdr:h, qdr:d, qdr:w, qdr:m, qdr:y) and custom date ranges (cdr:1,cd_min:MM/DD/YYYY,cd_max:MM/DD/YYYY)

locationstringOptional

Location parameter for search results (e.g. San Francisco,California,United States). For best results, set both this and the country parameter.

countrystringOptional

ISO country code for geo-targeting search results (e.g. US). For best results, set both this and the location parameter.

Default: USExample: US

timeoutintegerOptional

Timeout in milliseconds

Default: 60000Example: 60000

ignoreInvalidURLsbooleanOptional

Excludes URLs from the search results that are invalid for other Firecrawl endpoints. This helps reduce errors if you are piping data from search into other Firecrawl API endpoints.

Default: false

Responses

200Success

application/json

post

/v1/firecrawl

HTTPcURLJavaScriptPython

POST /v1/firecrawl HTTP/1.1
Host: search.onerouter.pro
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 495

{
  "model": "firecrawl-search",
  "query": "who is Leo Messi?",
  "limit": 5,
  "sources": [
    {
      "type": "web"
    }
  ],
  "categories": [
    {
      "type": "github"
    }
  ],
  "location": "US",
  "country": "US",
  "timeout": 60000,
  "ignoreInvalidURLs": false,
  "scrapeOptions": {
    "formats": [
      "markdown"
    ],
    "onlyMainContent": true,
    "maxAge": 172800000,
    "waitFor": 0,
    "mobile": false,
    "skipTlsVerification": true,
    "timeout": 123,
    "parsers": [
      "pdf"
    ],
    "location": {
      "country": "US",
      "languages": [
        "en-US"
      ]
    },
    "removeBase64Images": true,
    "blockAds": true,
    "proxy": "auto",
    "storeInCache": true
  }
}

200Success

{
  "success": true,
  "data": {
    "web": [
      {
        "url": "https://github.com/prathamSharma25/Lionel-Messi-Career-Analysis-EDA-ML/blob/main/Lionel-Messi-Career-Analysis.ipynb",
        "title": "Lionel-Messi-Career-Analysis.ipynb",
        "description": "Ever since enrolling himself at FC Barcelona youth academy, La Masia, at age 13, Lionel Messi has been a one-club-man. Having been offered a contract on a ...",
        "position": 1,
        "category": "github",
        "metadata": {
          "statusCode": 500,
          "error": "Scrape timed out",
          "proxyUsed": "basic"
        }
      },
      {
        "url": "https://github.com/prathamSharma25/Lionel-Messi-Career-Analysis-EDA-ML",
        "title": "prathamSharma25/Lionel-Messi-Career-Analysis-EDA-ML",
        "description": "Lionel Messi Career Analysis. This Data Science project consists of an Exploratory Data Analysis of football events dataset and other football related datasets ...",
        "position": 2,
        "category": "github",
        "metadata": {
          "statusCode": 500,
          "error": "Scrape timed out",
          "proxyUsed": "basic"
        }
      },
      {
        "url": "https://github.com/ak64119/Extract_Text_Information/blob/master/football_players.txt",
        "title": "Extract_Text_Information/football_players.txt at master",
        "description": "Lionel Andrés \"Leo\" Messi (born 24 June 1987) is an Argentine professional footballer who plays as a forward for Spanish club FC Barcelona and the Argentina ...",
        "position": 3,
        "category": "github",
        "metadata": {
          "statusCode": 500,
          "error": "Scrape timed out",
          "proxyUsed": "basic"
        }
      },
      {
        "url": "https://github.com/avishek-choudhary/Lionel-Messi-Club-Career-Goals-Analysis",
        "title": "Lionel-Messi-Club-Career-Goals-Analysis",
        "description": "The project was successful in answering the set of questions about Lionel Messi's Club Career Goals performance. The results of the project can be found in ...",
        "position": 4,
        "category": "github",
        "metadata": {
          "statusCode": 500,
          "error": "Scrape timed out",
          "proxyUsed": "basic"
        }
      },
      {
        "url": "https://github.com/topics/fc-barcelona",
        "title": "fc-barcelona · GitHub Topics",
        "description": "... Lionel Messi at FC Barcelona based on various crucial statistics. The ... lionel-messi leo-messi high-school-monte-caparica. Updated on Jul 3, 2019 ...",
        "position": 5,
        "category": "github",
        "metadata": {
          "statusCode": 500,
          "error": "Scrape timed out",
          "proxyUsed": "basic"
        }
      }
    ]
  },
  "creditsUsed": 5
}