Skip to content

Furry/amino-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Amino API

Discord Banner 2

Discord Shield Size Downloads


Amino API is a heavy wrapper around the reverse engineered Amino app. If you're looking for a completed library, this is NOT it, but is probably the closest you'll find.

Additions to this api are added on a random basis, basically whichever I feel should be done first. However, if you're looking for a specific feature, by all means make an issue requesting it and I'll make sure to add it first!

There is ZERO Error catching & handling at the moment. If something breaks and you don't know why, please make an issue so I can look into it.

What this library offers:

  • A functioning chat-based api
  • Dynamic user fetching
  • Strong typings for all endpoints

Example Pong Bot;

import * as Amino from "amino-api";

const client = new Amino.Client();

// To target which community the bot will be operating under (Default 'g' for global)
client.target("x235196899"); // This is furry amino.

client.login("username@gmail.com", "Password1234")
.then(() => {
    client.listen()
})

client.on("message", (message) => {
    if (message.content == "ping") {
        message.thread.send("pong!")
    }
})

The app has one API for both the main app & each community, communities have one app

To Implement

  • Error Handling
  • DM thread start capabilities
  • Posting
  • Commenting
  • Self Profile Editing
  • Generic API wrapping
  • Image Messages
  • Feature polling
  • Chatroom polling
  • Story polling
  • And so much more.

PR & Contribution Guidelines

  • All pull requests must provide valid reason for the change / implementation
  • All CORE CHANGES require an issue made before the PR will be looked at
  • All PR's must follow the general structure of this code base.
  • New structures must be defined similarely to how they are in the ./src/structs directory, with the typings below the class.
  • If you have any questions, feel free to make an issue and i'll answer asap!

PACKAGE NOTICE

This library name used to belong to https://github.com/amino/amino, a nodejs clustering manager, but ownership has been transfered and this module now represents https://github.com/furry/amino-api


Buy Me A Coffee

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published