Giter Club home page Giter Club logo

threads-wrapper's Introduction

threads-wrapper

NPM page Git license
API wrapper that allows developers to pull data from the new Threads social media platform.

Installation

You can use NPM to install this package in your project. Use the following command to install the package!

npm install threads-wrapper

After installation, require the package in your project by utilizing the follow lines of code:

const Threads_API = require("threads-wrapper");
let threads = new Threads_API();

Usage Examples

// Getting details on a Threads user and outputting it to the console

const getUserDetails = async (username) => {
    let userInfo = await threads.getUserData(username);
    console.log(
        "",
        `Name: ${userInfo.full_name}\n`,
        `Bio: ${userInfo.biography}\n`,
        `ID: ${userInfo.user_id}\n`,
        `Followers: ${userInfo.follower_count}\n`,
        `Website: ${userInfo.bio_links[0].url}`
    );
}
getUserDetails("Gisgar3");
// Retrieve a user's threads and outputting *just* the caption (if one exists)

const getUserThreads = async (username) => {
    let userThreads = await threads.getUserThreads(username);
    for (let num in userThreads) {
        if (userThreads[num].thread_items[0].post.caption) {
            console.log(`${userThreads[num].thread_items[0].post.caption.text}\n`);
        }
    }
}
getUserThreads("Gisgar3");

Current list of functions

retrieveUserId(username: String): Used to retrieve a user's Threads ID by username. Primarily used in other internal functions.

getUserData(username: String): Get a user's profile data by username. Returns JSON

getUserThreads(username: String): Get all threads from a user by username. Returns JSON

threads-wrapper's People

Contributors

gisgar3 avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

c4ei

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.