EnsembleData Node.js API

Documentation

Check out the API docs to see which endpoints are available for each social media and for detailed descriptions of their parameters and functionality.

Installation

Install the package with npm, pnpm or yarn.

npm install ensembledata

yarn add ensembledata

pnpm add ensembledata

Requirements

• The package requires Node 18 or higher.

Usage

Register to get your free API token.

import { EDClient } from "ensembledata";

const client = EDClient({ token: "API-TOKEN" });
const result = await client.tiktok.userInfoFromUsername({
    username: "daviddobrik",
});

console.log("Data: ", result.data);
console.log("Units charged:", result.unitsCharged);

// Other Examples:
// const result = await client.instagram.userInfo({ username: "daviddobrik" })
// const result = await client.youtube.channel_subscribers({ channelId: "UCnQghMm3Z164JFhScQYFTBw" })

Missing Endpoints / Parameters

If you find that one of the endpoints from our API docs is not yet available in this package, you can use the EDClient.request method to specify the endpoint manually in the meantime.

import { EDClient } from "ensembledata";

const client = EDClient({ token: "API-TOKEN" });
const result = await client.request("/instagram/example", {
    foo: "...",
    bar: "...",
});

If you find that one the parameters to an existing endpoint is missing, you can still send this parameter via the extraParams which is available on all endpoint methods as shown below:

import { EDClient } from "ensembledata";

const client = EDClient({ token: "API-TOKEN" });
const result = await client.instagram.userInfo(
    { username: "..." },
    {
        extraParams: {
            baz: "...",
        },
    },
);

Handling Errors

In the API docs, each endpoint lists a handful of possible errors the API may respond with. You can handle these errors by catching the EDError exception.

import { EDClient, errors } from "ensembledata";

const client = EDClient({ token: "API-TOKEN" });
try {
    const result = await client.tiktok.userInfoFromUsername({
        username: "daviddobrik",
    });
} catch (error) {
    switch (error.statusCode) {
        // Rate limit exceeded...
        case errors.STATUS_429_RATE_LIMIT_EXCEEDED:
            console.log(error.detail);
            break;

        // Subscription expired...
        case errors.STATUS_493_SUBSCRIPTION_EXPIRED:
            console.log(error.detail);
            break;

        // Some other error occurred, unrelated to the EnsembleData API
        default:
            break;
    }
}

Using Promises

Every endpoint method returns a promise. You can use the .then() and .catch() methods to handle the result and errors respectively.

import { EDClient } from "ensembledata";

const client = EDClient({ token: "API-TOKEN" });
client.tiktok
    .userInfoFromUsername({ username: "daviddobrik" })
    .then((result) => {
        console.log("Data: ", result.data);
        console.log("Units charged:", result.unitsCharged);
    })
    .catch((error) => {
        console.log("Error: ", error);
    });

Network Retries

By default the EDClient will perform 3 retries when it encounters network issues. If you would like to customise this behaviour, you can pass in the maxNetworkRetries param as show below:

Note: if the request times out, it will not be retried.

import { EDClient } from "ensembledata";

const client = EDClient({ token: "API-TOKEN", maxNetworkRetries: 5 });

Configure Timeout

If you would like control over the timeout, you can configure this either for all request by setting timeout (in seconds) when creating the EDClient, or you can specify the timeout per request, on any of the individual methods as shown below:

import { EDClient } from "ensembledata";

const client = EDClient({ token: "API-TOKEN", timeout: 120 });
const result = await client.instagram.userInfo(
    { username: "..." },
    { timeout: 10 },
);

Types

This package provides TypeScript types for all the endpoints and their parameters. You can use these types to get autocompletion and type checking in your IDE. Internally the package uses JSDoc comments to provide these types. If you experience any typing problems, please let us know by creating an issue.