API documentation

Endpoints

GET/

Index

Landing page

No arguments available for this endpoint

GET/signup

Signup

Signup page

No arguments available for this endpoint

POST/signup

Signup processor

Signup form processor

Arguments
Name Type Required Description
username string true Username of the new account
email string true Email address of the new account

GET/login

Login

Login page

No arguments available for this endpoint

POST/login

Login processor

Login form processor

Arguments
Name Type Required Description
username string true Username or email address of the new account

GET/logout

Logout

Destroys user session

No arguments available for this endpoint

GET/snapshots

Snapshots

Search in snapshots by URL
Add ?format=rss for RSS output

Arguments
Name Type Required Description
query string false Search term to filter snapshots

GET/bookmarks

Public bookmarks

List public bookmarks with optional filters
Add ?format=rss for RSS output

Arguments
Name Type Required Description
query string false Search term to filter bookmarks by title
owner string false Search term to filter bookmarks by username
tag string false Search term to filter bookmarks by tag
domain string false Search term to filter bookmarks by domain
from date false Display only newer bookmarks. (Format: YYYY.MM.DD)
to date false Display only older bookmarks. (Format: YYYY.MM.DD)
search_in_snapshots boolean false Query parameter also applied to snapshot content. (Values: 0, 1)
search_in_notes boolean false Query parameter also applied to bookmark notes. (Values: 0, 1)

GET/snapshot

Snapshot

Displays snapshots details with additional bookmark properties

Arguments
Name Type Required Description
sid string true Snapshot key
bid int true Bookmark ID

GET/download_snapshot

Download snapshot

Download a self contained single file version of a snapshot

Arguments
Name Type Required Description
sid string true Snapshot key

GET/snapshot_details

Snapshot details

View snapshot details and resources

Arguments
Name Type Required Description
sid string true Snapshot key

POST/add_bookmark

Add bookmark

Add new bookmark

Arguments
Name Type Required Description
token string true Extension token. It can be found on the profile page
url URL true URL of the bookmark
title string true Title of the bookmark
notes string false Bookmark notes
favicon string false Data URL encoded favicon (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs)
public boolean false Marks bookmark as public
tags string false Comma separated list of tags
snapshot_title string false Title of the snapshot
snapshot_text string false Text content of the snapshot
snapshot multipart file false Snapshot file

POST/add_resource

Add resource

Add new resource to a snapshot

Arguments
Name Type Required Description
token string true Extension token. It can be found on the profile page
sid string true Snapshot ID
meta JSON string true List of resource metadata containing objects with mimetype, extension and filename information
resource[0-9]+ multipart files true Resource files

GET/check_bookmark

Check bookmark

Checks if a bookmark is already exists

Arguments
Name Type Required Description
token string true Extension token. It can be found on the profile page
url URL true URL of the bookmark

GET/bookmark

Bookmark

Displays all details of a bookmark

Arguments
Name Type Required Description
id int true Bookmark ID

GET/api

API

Displays API documentation (this page)

No arguments available for this endpoint

GET/oauth

Oauth

Creates OAuth requests

Arguments
Name Type Required Description
provider string true Oauth provider name

GET/oauth_redirect_handler

Oauth verification

Verifies OAuth requests

No arguments available for this endpoint

GET/profile

Profileauthentication required

Displays the user profile page

No arguments available for this endpoint

POST/profile

Profile pageauthentication required

Displays the profile page with addon tokens

No arguments available for this endpoint

GET/generate_addon_token

Generate addon tokenauthentication required

Creates a new addon token

No arguments available for this endpoint

POST/delete_addon_token

Delete addon tokenauthentication required

Deletes an addon token

Arguments
Name Type Required Description
id int true Token ID

GET/create_bookmark

Create bookmark formauthentication required

Show create bookmark form

No arguments available for this endpoint

POST/create_bookmark

Create bookmarkauthentication required

Create new bookmark from webapp

Arguments
Name Type Required Description
url string true URL of the bookmark
title string true Title of the bookmark
notes string false Bookmark notes
public boolean false Bookmark is publicly accessible

GET/my_bookmarks

My bookmarksauthentication required

Displays bookmarks belongs to the current user with optional filters
Add ?format=rss for RSS output

Arguments
Name Type Required Description
query string false Search term to filter bookmarks by title
tag string false Search term to filter bookmarks by tag
domain string false Search term to filter bookmarks by domain
from date false Display only newer bookmarks. (Format: YYYY.MM.DD)
to date false Display only older bookmarks. (Format: YYYY.MM.DD)
is_public boolean false Display only public bookmarks. (Values: 0, 1)
is_private boolean false Display only private bookmarks. (Values: 0, 1)
search_in_snapshots boolean false Query parameter also applied to snapshot content. (Values: 0, 1)
search_in_notes boolean false Query parameter also applied to bookmark notes. (Values: 0, 1)

GET/edit_bookmark

Edit bookmarkauthentication required

Displays a bookmark with all the editable properties

Arguments
Name Type Required Description
id int true Bookmark ID

POST/save_bookmark

Save bookmarkauthentication required

Saves an edited bookmark

Arguments
Name Type Required Description
id int true Bookmark ID
title string true Title of the bookmark
notes string false Bookmark notes
public boolean false Bookmark is publicly accessible. (Omit this argument in case of private bookmarks)

POST/delete_snapshot

Delete snapshotauthentication required

Deletes a snapshot

Arguments
Name Type Required Description
bid int true Bookmark ID
sid int true Snapshot ID

POST/delete_bookmark

Delete bookmarkauthentication required

Deletes a bookmark

Arguments
Name Type Required Description
id int true Bookmark ID

POST/add_tag

Add tagauthentication required

Add tag to a bookmark

Arguments
Name Type Required Description
bid int true Bookmark ID
tag string true Tag string

POST/delete_tag

Delete tagauthentication required

Delete tag's bookmark

Arguments
Name Type Required Description
bid int true Bookmark ID
tid int true Tag ID