dataforseo v1.2.1

Data For SEO API (for javascript)

(HTML Coverage Report)

Official Documentation

https://docs.dataforseo.com/v3/

Purpose

The purpose of this library is to expose the wonderful Data For SEO rest API to javascript applications easily. Without having to write your own API calls and whatnot. It should work out of the box with only needing to provide your account's credentials for authorization purposes.

Getting Started

npm install dataforseo --save

Ideal Usage (vanilla JS)

require("dotenv").config();
var DFSEO = require("dataforseo");

var username = process.env.DATAFORSEO_USERNAME;
var password = process.env.DATAFORSEO_PASSWORD;

var dfseo = new DFSEO(username, password);
// var dfseo = new DFSEO(username, password, true) to use sandbox api

dfseo.serp.google.organic
  .taskPost([
    {
      keyword: "test",
      priority: 1,
      location_code: 2840,
      language_code: "en"
    }
  ])
  .then(res => {
    console.log(res);
  })
  .catch(err => {
    console.log(err);
  });

Ideal Usage (TypeScript/ES6)

Note Types are incomplete

import  DFSEO  from 'dataforseo';
import * as dotenv from 'dotenv';
dotenv.config();

const username = process.env.DATAFORSEO_USERNAME;
const password = process.env.DATAFORSEO_PASSWORD;

const dfseo = new DFSEO(username, password);
//const dfseo = new DFSEO(username, password, true) to use sandbox api

async function main(){
    try{
        const response = await dfseo.serp.google.organic.taskPost([
            keyword: 'test',
            priority: 1,
            location_code: 2840,
            language_code: 'en'
        ]);

        console.log(response);
    }catch(e){
        console.log(e);
    }
}

Support

Currently this library only supports version 3 of the DataForSEO API. sorry!

Documentation Map

Figured it would just be easiest to line up what api calls go to where. For endpoints requiring an id example simply pass the id as an argument to the method. For endpoints requiring a task follow the requirements in the documentation and pass the data as an object to the method (as shown in the examples above).