aops-js

1.1.1 • Public • Published

AoPS JS

An unofficial API for the Art of Problem Solving Website.

Installation

$ npm install aops-js
$ yarn add aops-js

Usage

Top level await is supported in Node version 13.3 or higher. If not, you must wrap it around an async function.

import AoPS from "aops-js";

(async () => {
  const aops = await new AoPS({ verbose: true });
})();

Login

aops.login({ username: "x", password: "x" });
Params

Required:

username
password

Submit Post

aops.submitPost({ post_text: "Hello World!", topic_id: "3156623" });
Params
Required:
post_text
topic_id

Optional:

notify_email
allow_latex_errors
last_post_num
disable_bbcode
is_announcement

Submit New Topic

await aops.submitNewTopic({
  post_text: "Hello World!",
  title: "Hello World!",
  category_id: "1"
});
Params

Required:

category_id
title
post_text

Optional:

tags
linked_tag
target_url
target_text
source
post_as_halp
pm_as_sheriff
allow_latex_errors
hidden_tags
restricted_tags
removed_autotags
notify_email
attachments
has_poll
poll_data
recipients
disable_bbcode
is_local_announcement
is_global_announcement
announce_through

Fetch Topics

await aops.fetchTopics({
  category_id: "1946392",
  category_type: "blog"
});
Params

Required:

category_id
category_type

Optional:

log_visit
required_tag
fetch_before
user_id
fetch_archived
fetch_announcements

Get User Avatar (URL)

await aops.getUserAvatar({ aops_user_id: "1" });
Params
Required:
aops_user_id

Readme

Keywords

none

Package Sidebar

Install

npm i aops-js

Weekly Downloads

0

Version

1.1.1

License

MIT

Unpacked Size

9.33 kB

Total Files

5

Last publish

Collaborators

  • cubingsoda