WebSearchAPI#

A multi-type search tool based on SearchAPI (Google), ideal for agents to retrieve real-time web information.

Features#

• Multiple Search Types: Web, News, Video, Finance, Maps, Hotels, Flights
• Time Filtering: Search by time range
• Auto Retry: Automatic retry on network errors for stability
• Structured Output: Agent-ready JSON format
• Zero Dependencies: Pure Node.js built-in modules

Installation#

bash

# Copy tools/websearchapi to your project
# Configure API Key (required)
cd tools/websearchapi
node websearchapi.js config set-key YOUR_API_KEY

Get API Key: https://searchapi.io (Free registration)

⚠️ Important: Use your own API Key, not someone else's

Usage#

Call via exec tool:

bash

node <path>/websearchapi.js <command> [keyword] [options]

Search Types#

TypeCommandDescriptionWebs or searchGeneral web searchNewsnewsLatest newsVideovideoVideo searchFinancefinanceStock/Financial infoMapsmapsPlaces/BusinessHotelshotelsHotel searchFlightsflightsFlight search

Options#

OptionDescriptionDefault--numNumber of results5--langLanguagezh-CN--glCountrycn--timeTime rangenone--jsonJSON outputtext

Time Filtering#

ValueDescriptionlast_hourPast hourlast_dayPast daylast_weekPast weeklast_monthPast monthlast_yearPast year

Agent Examples#

bash

# Web search
node websearchapi.js s "MCP protocol"

# News search (past week)
node websearchapi.js news "AI" --time=last_week

# Finance search
node websearchapi.js finance "AAPL"

# Time filter (past 24 hours)
node websearchapi.js s "keyword" --time=last_day

# JSON format (recommended for parsing)
node websearchapi.js s "keyword" --json

Response Format#

JSON mode returns:

json

{
  "success": true,
  "query": "keyword",
  "type": "google",
  "count": 5,
  "results": [
    {
      "title": "Result Title",
      "link": "URL",
      "snippet": "Summary",
      "source": "Source"
    }
  ],
  "metadata": {
    "totalResults": number,
    "timeTaken": seconds,
    "engine": "google"
  }
}

Configuration#

First Time - Configure API Key#

bash

cd tools/websearchapi
node websearchapi.js config set-key YOUR_API_KEY

View/Modify Config#

bash

# View config (Key hidden)
node websearchapi.js config

# Set API Key
node websearchapi.js config set-key YOUR_API_KEY

# Modify defaults
node websearchapi.js config set-num 10      # Default result count
node websearchapi.js config set-lang en     # Default language
node websearchapi.js config set-gl us       # Default country
node websearchapi.js config set-retry 5     # Retry count

Deployment#

bash

# Copy to new machine
scp -r ./tools/websearchapi user@new-server:/path/to/tools/

# Configure your own API Key
cd /path/to/tools/websearchapi
node websearchapi.js config set-key YOUR_API_KEY

# Test
node websearchapi.js test

Troubleshooting#

Search Failed#

• Check API Key: node websearchapi.js config
• Verify Key: https://searchapi.io/dashboard

Finance No Results#

• Try stock code: finance "AAPL"
• Try English: finance "Tesla stock"

Request Timeout#

• Increase retry: config set-retry 5

Security Notes#

• ⚠️ Always use your own API Key
• 🔐 API Key stored in local config.json
• 🚫 Don't share packages with API Key included