pr0gramm-api

A Node.js API for pr0gramm written in TypeScript.

1npm install -S pr0gramm-api

Usage

Login with username/password:

1import { Pr0grammAPI, NodeRequester, ItemFlags } from "pr0gramm-api";
2
3main();
4async function main() {
5    const requester = NodeRequester.create();
6    // When using this library in the browser, use this requester:
7    // const requester = BrowserRequester.create();
8
9    const api = Pr0grammAPI.create(requester);
10
11    const mainItems = await api.items.getItems({
12        promoted: true,
13        flags: ItemFlags.SFW
14    });
15
16    console.log(mainItems.items);
17
18    const captchaData = await api.user.requestCaptcha();
19    // captchaData.captcha contains the image as a data URI
20
21    const loginResponse = await api.user.login("cha0s", "stahl0fen80", captchaData.token, "aaaaa");
22    if(!loginResponse.success) {
23        console.log("Could not log in :(");
24        if(loginResponse.ban !== null) {
25            console.log("You are banned. Reason:");
26            console.log(loginResponse.ban.reason);
27            return;
28        }
29    }
30}

Login with oAuth:

1import * as readline from "node:readline/promises";
2import { AuthorizationCode } from "simple-oauth2";
3import { Pr0grammAPI, NodeRequester, ItemFlags } from "pr0gramm-api";
4
5const oAuthAccessCodeClient = new AuthorizationCode({
6    client: {
7        // See above
8        id: "<client_id>",
9        secret: "<client_secret>",
10    },
11    auth: {
12        tokenHost: "https://pr0gramm.com/",
13        tokenPath: "/api/oauth/createAccessToken",
14        authorizePath: "/oauth/authorize",
15    }
16});
17
18main();
19async function main() {
20    const authorizationUri = oAuthAccessCodeClient.authorizeURL({
21        redirect_uri: authCallbackUrl,
22        scope: "items.get",
23        state: "<state>",
24    });
25
26    console.log("Go to this URL and enter the auth code from ?code=<auth code> from the callback URL:");
27    console.log(authorizationUri);
28
29    const rl = readline.createInterface({
30        input: process.stdin,
31        output: process.stdin,
32    });
33    const authCode = await rl.question("Auth-Code: ");
34    rl.close();
35
36    const tokenHandler = await oAuthAccessCodeClient.getToken({
37        code: authCode,
38    });
39
40    const requester = NodeRequester.create();
41    requester.setOAuthAccessToken(tokenHandler.token.access_token);
42
43    const api = Pr0grammAPI.create(requester);
44
45    const mainItems = await api.items.getItems({
46        promoted: true,
47        flags: ItemFlags.All
48    });
49
50    console.log(mainItems.items);
51}

Stream Walker

The item stream requires you to call the next page of elements. Because it is a common operation to just walk over all items in the stream, there is a stream walker api for convenience:

1import { Pr0grammAPI, NodeRequester, ItemFlags } from "pr0gramm-api";
2
3main();
4async function main() {
5    const api = Pr0grammAPI.create(NodeRequester.create());
6
7    // Create a walker that iterates through the entire stream of elements
8    // starting at item 0, going upwards
9    const itemStream = api.items.walkStreamNewer({
10        newer: 0,
11        flags: ItemFlags.SFW,
12        promoted: false,
13    });
14
15    // Asynchronous iteration over all items on pr0gramm
16    // automatically requests next items
17    for await (const item of itemStream) {
18        console.log(item.id + ": " + item.user);
19    }
20}

Important:

• This approach uses async generators, which are currently hidden behind node's --harmony flag. To use this API, you need to start node with --harmony.
• If you are using TypeScript, you need to have "esnext.asynciterable" and "es6" in your lib entry in tsconfig.json.
• The module is exposed as CommonJS, not (yet) ES modules. If you use plain JavaScript, keep in mind using CommonJS imports instead of ES imports: const { Pr0grammAPI, ItemFlags } = require("pr0gramm-api");