Node.js - Snipp

snipp-gg/snipp-js

@snipp-gg/snipp

Installation

npm install @snipp-gg/snipp

Requires Node.js 18 or later. Zero dependencies. Uses native fetch and FormData.

Getting Started

import { SnippClient } from "@snipp-gg/snipp";

const client = new SnippClient({ apiKey: process.env.SNIPP_API_KEY });

const me = await client.getUser("@me");
console.log(me.user.username);

Regional endpoints

Pass region to pin the client to a specific regional host. Uploads run at the same speed either way; this controls which region stores your files.

const client = new SnippClient({
  apiKey: process.env.SNIPP_API_KEY,
  region: "eu-west-1", // or "us-west-1"
});

Methods

`getUser(id, options?)`

Fetch a user by ID. Pass "@me" for the authenticated user.

Option	Type	Description
`includePosts`	`boolean`	Include the user’s public uploads.
`postsLimit`	`number`	Number of posts to return (1 to 50).

const user = await client.getUser("@me", { includePosts: true, postsLimit: 10 });

`getPost(code)`

Fetch a post by its share code. Team posts are only readable by members of that team, and omit likeCount.

const post = await client.getPost("AbCd1234");
console.log(post.post.url);

`upload(file, options?)`

Upload a file. Accepts a File, Blob, Buffer, or Uint8Array.

Option	Type	Description
`privacy`	`"public" \| "unlisted" \| "private"`	Visibility of the upload. Defaults to `private` when omitted.
`filename`	`string`	Filename sent with the upload (defaults to `"upload"`).
`title`	`string`	Optional post title (max 30 chars).
`description`	`string`	Optional post description (max 200 chars).
`postType`	`"album" \| "individual"`	`album` (default) or `individual`. Only applies when uploading two or more files.

import { readFileSync } from "node:fs";

const buffer = readFileSync("./image.png");
const result = await client.upload(buffer, { privacy: "unlisted", filename: "image.png" });
console.log(result.url);

`listUploads(options?)`

List the authenticated user’s recent uploads. Defaults to 30. Pass limit to control the count (max 1000).

Option	Type	Description
`limit`	`number`	Maximum uploads to return (1-1000).

const uploads = await client.listUploads({ limit: 100 });

`editUpload(code, options)`

Edit an existing upload’s title, description, or privacy.

Option	Type	Description
`title`	`string`	New title (max 30 chars). Empty string to clear.
`description`	`string`	New description (max 200 chars). Empty string to clear.
`privacy`	`"public" \| "unlisted" \| "private"`	New visibility setting.

await client.editUpload("AbCd1234", { title: "New title", privacy: "public" });

`appendUpload(code, files, options?)`

Add one or more files to an existing album post. The post’s share code, privacy, title, and description are preserved. Albums cap at 50 files total. Requests that would exceed the cap are rejected. New files inherit the post’s privacy. Returned URLs are signed with a 24-hour expiry for private posts.

Parameter	Type	Description
`code`	`string`	Share code of the post to append to.
`files`	`Array<File \| Blob \| Buffer \| Uint8Array>`	One or more files to append.
`options.filenames`	`string[]`	Optional filenames (one per file).

import { readFileSync } from "node:fs";

const a = readFileSync("./photo-a.png");
const b = readFileSync("./photo-b.png");

const result = await client.appendUpload("AbCd1234", [a, b], {
  filenames: ["photo-a.png", "photo-b.png"],
});
console.log(result.post.fileCount);

`deleteUpload(filename)`

Delete an upload by its filename. On albums, only that file is removed; on single-file posts the entire post is deleted.

await client.deleteUpload("a3f7b2c91d4e8f0612ab34cd56ef7890.png");

`reportPost(code, reason?)`

Report a post, with an optional reason (max 200 chars).

await client.reportPost("AbC123", "Spam");

Error Handling

All API errors throw a SnippError with status, message, and body properties. body is the parsed JSON error response, or null when the response was not JSON. It carries the fields the API sends alongside error, such as suspended on a suspended user or moderated on a moderated post.

import { SnippClient, SnippError } from "@snipp-gg/snipp";

try {
  await client.getUser("987654321098765432");
} catch (err) {
  if (err instanceof SnippError) {
    if (err.body?.suspended) {
      console.error(`${err.body.username} is suspended`);
    } else {
      console.error(err.status, err.message);
    }
  }
}

​Installation

​Getting Started

​Regional endpoints

​Methods

​getUser(id, options?)

​getPost(code)

​upload(file, options?)

​listUploads(options?)

​editUpload(code, options)

​appendUpload(code, files, options?)

​deleteUpload(filename)

​reportPost(code, reason?)

​Error Handling