❤
npm
Sign UpSign In

This package has been deprecated

Author message:

musically-api has been renamed to tiktok-api; please use the latest version of tiktok-api instead of this package

musically-api
TypeScript icon, indicating that this package has built-in type declarations

0.2.0 • Public • Published

Unofficial Musical.ly API · npm version Coverage Status Build Status PRs Welcome Supported musical.ly version

A reverse-engineered implementation of the musical.ly app's API.

Installation

npm i musically-api

Usage

Creating an instance

import MusicallyAPI, { getRequestParams } from 'musically-api';
 
// Required - a method that signs the URL with anti-spam parameters
// You must provide an implementation yourself to successfully make
// most requests with this library.
const signURL = async (url, ts, deviceId) => {
  const as = 'anti-spam parameter 1';
  const cp = 'anti-spam parameter 2'
  const mas = 'anti-spam parameter 3';
  return `${url}&as=${as}&cp=${cp}&mas=${mas}`;
}
 
// Required - device parameters
// You need to source these using a man-in-the-middle proxy such as mitmproxy,
// CharlesProxy or PacketCapture (Android)
const params = getRequestParams({
  device_id: '<device_id>',
  fp: '<device_fingerprint>',
  iid: '<install_id>',
  openudid: '<device_open_udid>',
});
 
const api = new MusicallyAPI(params, { signURL });
 
// You are now able to make successful requests
 

Instance methods

#loginWithEmail(email, password)

Authenticates you with the API and stores your session data in a cookie jar. Subsequent requests will include these cookies.

api.loginWithEmail('<email>', '<password>')
  .then(res => console.log(res.data))
  .catch(console.log)
 
// Outputs:
// { email: '<email>', session_key: '123456', user_id: '123456', ... }
 

See the login types for the response data.

#getUser(id)

Gets a user's profile.

api.getUser('<user_id>')
  .then(res => console.log(res.data.user))
  .catch(console.log);
 
// Outputs:
// { aweme_count: 1000, nickname: 'example', unique_id: 'musername', ... }
 

See the user types for the response data.

#listPosts(params)

Lists a user's posts.

api.listPosts({
  user_id: '<user_id>',
  max_cursor: 0,
})
  .then(res => console.log(res.data.aweme_list))
  .catch(console.log);
 
// Outputs:
// [{ author: {...}, aweme_id: '999', desc: 'description', music: {...}, statistics: {...}, video: {...} }, ...]
 

See the post types for the complete request/response objects.

#listFollowers(params)

Lists the users that follow the specified user.

api.listFollowers({
  user_id: '<user_id>',
  max_time: Math.floor(new Date().getTime() / 1000),
})
  .then(res => console.log(res.data.followers))
  .catch(console.log);
 
// Outputs:
// [{ unique_id: 'follower1' }, { unique_id: 'follower2' }, ...]
 

See the follower types for the complete request/response objects.

Resources

Legal

This code is in no way affiliated with, authorized, maintained, sponsored or endorsed by musical.ly or any of its affiliates or subsidiaries. This is an independent and unofficial API. Use at your own risk.

Readme

Keywords

Package Sidebar

Install

npm i musically-api

Repository

github.com/szdc/musically-api

Homepage

github.com/szdc/musically-api#readme

Weekly Downloads

5

Version

0.2.0

License

MIT

Unpacked Size

50.1 kB

Total Files

35

Last publish

Collaborators

  • szdc
Try on RunKit
Report malware