There is a TypeScript client to call DataForSEO API.
DataForSEO API uses REST technology for interchanging data between your application and our service. The data exchange is made through the widely used HTTP protocol, which allows applying our API to almost all programming languages.
Client contains 12 sections (aka API):
- Serp (source docs | api docs)
- KeywordsData (source docs | api docs)
- DomainAnalytics (source docs | api docs)
- DataforseoLabs (source docs | api docs)
- Backlinks (source docs | api docs)
- OnPage (source docs | api docs)
- ContentAnalysis (source docs | api docs)
- ContentGeneration (source docs | api docs)
- Merchant (source docs | api docs)
- AppData (source docs | api docs)
- BusinessData (source docs | api docs)
- Appendix (source docs | api docs)
API Contains 2 types of requests:
- Live (Simple HTTP request/response message)
- Task-Based (Where you need to send a 'Task' entity to execute, waiting until the 'Task' status is ready and getting the 'Task' result in a special endpoint. It is represented in 3 endpoints 'TaskPost', 'TaskReady' and 'TaskGet')
For more details - please follow here
Our API description is based on openAPI syntax in YAML format. The YAML file attached to the project here
The documentation for code objects, formatted in Markdown (.md) is available here. Offical documentation for DataForSeo API is avaliable here.
Code generated with using NSwag lib
npm install dataforseo-client Example of live request
import * as client from 'dataforseo-client'
async function main() {
const username = 'username';
const password = 'password';
const authFetch = createAuthenticatedFetch(username, password);
let serpApi = new client.SerpApi("https://api.dataforseo.com", { fetch: authFetch });
let task = new client.SerpTaskRequestInfo();
task.location_code = 2840;
task.language_code = "en";
task.keyword = "albert einstein"
let resp = await serpApi.googleOrganicLiveAdvanced([task]);
}
function createAuthenticatedFetch(username: string, password: string) {
return (url: RequestInfo, init?: RequestInit): Promise<Response> => {
const token = btoa(`${username}:${password}`);
const authHeader = { 'Authorization': `Basic ${token}` };
const newInit: RequestInit = {
...init,
headers: {
...init?.headers,
...authHeader
}
};
return fetch(url, newInit);
};
}
main();Example of Task based endpoint
import * as client from 'dataforseo-client'
async function main() {
const username = 'username';
const password = 'password';
const authFetch = createAuthenticatedFetch(username, password);
let serpApi = new client.SerpApi("https://api.dataforseo.com", { fetch: authFetch });
let task = new client.SerpTaskRequestInfo();
task.location_code = 2840;
task.language_code = "en";
task.keyword = "albert einstein"
let taskResponse = await serpApi.googleOrganicTaskPost([task])
let taskID = taskResponse.tasks[0].id;
const startTime = Date.now();
while (!await isReady(serpApi, taskID) && Date.now() - startTime < 60000) {
await new Promise(resolve => setTimeout(resolve, 1000));
}
let resp = await serpApi.googleOrganicTaskGetAdvanced(taskID);
}
async function isReady(serpApi: client.SerpApi, id: string): Promise<boolean> {
let resp = await serpApi.googleOrganicTasksReady();
let isReadyId = false;
resp.tasks.forEach(x => {
if (x.id == id) {
isReadyId = true;
}
});
return isReadyId;
}
function createAuthenticatedFetch(username: string, password: string) {
return (url: RequestInfo, init?: RequestInit): Promise<Response> => {
const token = btoa(`${username}:${password}`);
const authHeader = { 'Authorization': `Basic ${token}` };
const newInit: RequestInit = {
...init,
headers: {
...init?.headers,
...authHeader
}
};
return fetch(url, newInit);
};
}
main();