Node.js SDK

The official Node.js SDK makes it easy to integrate the SERPHouse API into any Node.js application.

Instead of manually creating HTTP requests, the SDK handles authentication, request formatting, and response parsing so you can focus on building your application.

The SDK provides access to:

• Google SERP API

• Bing SERP API

• Yahoo SERP API

• Domains

• Languages

• Locations

• Account information

SERPHouse Node.js SDK on GitHub

SERPHouse Node.js on NPM

---

Requirements

• Node.js 16+

• npm or yarn

---

Installation

Install the SDK using npm.

npm install serphouse

or with Yarn

yarn add serphouse

---

Get Your API Key

Create a SERPHouse account and generate an API key from your dashboard.

---

Initialize the Client

const { SERPHouseClient } = require("serphouse");

const client = new SERPHouseClient({
    apiKey: process.env.SERPHOUSE_API_KEY,
});

Using environment variables is recommended.

SERPHOUSE_API_KEY=your_api_key

---

Quick Start

Perform a live Google search.

const response = await client.serp.live({
    data: {
        q: "Coffee",
        domain: "google.com",
        lang: "en",
        loc: "Texas, United States",
        device: "desktop",
        serp_type: "web",
    },
});

console.log(response);

---

Available Services

The SDK exposes the following services.

Service	Description
client.serp	Google, Bing & Yahoo SERP APIs
client.domains	Supported domains
client.languages	Supported languages
client.locations	Search locations
client.account	Account information

---

SERP API

Live Search

Retrieve search results immediately.

const response = await client.serp.live({
    data: {
        q: "Coffee",
        domain: "google.com",
        lang: "en",
        device: "desktop",
        serp_type: "web",
        loc: "Texas, United States",
        page: 1,
        num_result: 10,
    },
});

---

Schedule a Search

Schedule searches for asynchronous processing.

const response = await client.serp.schedule({
    data: [
        {
            q: "Coffee",
            domain: "google.com",
            lang: "en",
            device: "desktop",
            serp_type: "web",
            loc: "Texas, United States",
            postback_url: "https://example.com/postback",
            pingback_url: "https://example.com/pingback",
        },
    ],
});

---

Check Search Status

const response = await client.serp.check(searchId);

---

Get Search Results

const response = await client.serp.get(searchId);

Retrieve raw HTML.

const response = await client.serp.get(searchId, "html");

---

Domains

Retrieve all supported search domains.

const response = await client.domains.list();

---

Languages

Retrieve supported languages.

const response = await client.languages.list();

Retrieve Bing languages.

const response = await client.languages.list({
    type: "bing",
});

---

Locations

Search available locations.

const response = await client.locations.search({
    q: "Texas",
});

---

Account

Retrieve account details.

const response = await client.account.info();

---

Error Handling

Handle API errors using try...catch.

try {    const response = await client.serp.live({        data: {            q: "Coffee",        },    });    console.log(response);} catch (error) {    console.error(error.message);}

---

Using Async/Await

All SDK methods return Promises.

try {
    const response = await client.serp.live({
        data: {
            q: "Coffee",
        },
    });

    console.log(response);
} catch (error) {
    console.error(error.message);
}

---

Environment Variables

Store your API key securely.

SERPHOUSE_API_KEY=your_api_key

require("dotenv").config();

const { SERPHouseClient } = require("serphouse");

const client = new SERPHouseClient({
    apiKey: process.env.SERPHOUSE_API_KEY,
});

---

Complete Example

require("dotenv").config();

const { SERPHouseClient } = require("serphouse");

const client = new SERPHouseClient({
    apiKey: process.env.SERPHOUSE_API_KEY,
});

async function main() {
    const results = await client.serp.live({
        data: {
            q: "Coffee",
            domain: "google.com",
            lang: "en",
            device: "desktop",
            serp_type: "web",
        },
    });

    console.log(results);
}

main();

---

Support

If you encounter any issues while installing, configuring, or using the SERPHouse Node.js SDK, we're here to help.

• Contact the SERPHouse support team for assistance.

• Report bugs or request features by opening an issue on the GitHub repository.

GitHub Repository:

https://github.com/SERPHouse/serphouse-nodejs