Shaarli

Shaarli is an open‑source, self‑hosted bookmarking service that lets users store, tag, and share web links. Designed for personal use, it is minimalist, fast, and requires no database, using flat‑file storage instead. The project provides a web interface, a public demo instance, and a REST API for programmatic access. It is written in PHP, released under the MIT license, and can be deployed via Docker or traditional web servers. The community maintains documentation on Read the Docs and offers a client library ecosystem.

Shaarli is listed with 2 APIs on the APIs.io network. Tagged areas include Bookmarking, Self-hosted, Open-source, PHP, and Minimalist.

The Shaarli catalog on APIs.io includes 1 Spectral governance ruleset.

Shaarli’s developer surface includes changelog, authentication, documentation, API reference, getting-started guide, support, and 10 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

28.5/100 thin Agent 20/100 agent aware Full breakdown ↓
scored 2026-10-31 · rubric v0.25.0 · Show this score on your site →

2 APIs

BookmarkingSelf-hostedOpen-sourcePHPMinimalist

Kin Score

Kin Score How this is scored →
scored 2026-10-31 · rubric v0.25.0

Composite quality — 28.5/100 · thin

Contract Quality 2.0 / 21

Developer Ergonomics 7.7 / 17

Access Clarity 2.2 / 17

Operational Transparency 2.3 / 11

Contract Governance 3.6 / 10

Discoverability 4.9 / 9

Regulatory Posture 4.0 / 15

Agent readiness — 20/100 · agent aware

Machine-Readable Contract 18 / 18

Agentic Access Contract 0 / 10

Documented Reversibility 0 / 6

MCP Server 0 / 12

Machine-Readable Auth 10 / 10

Idempotency 0 / 9

Stable Error Semantics 8 / 8

Request/Response Examples 0 / 7

Rate-Limit Signaling 0 / 7

Typed Event Surface 0 / 6

Agent Skills 0 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 0 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

Pagination 5 / 5

Distinct Operations 3 / 3

Regulatory Posture applies to this provider. Its tags matched the Horizontal (data, software, accessibility, platform) regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics could not be measured. We hold no machine-readable contract for this provider to read, so there is nothing to measure a write surface against. Excluded rather than scored zero: never-measured and measured-empty are different facts. Publishing an OpenAPI is what makes this facet — and several others — scorable at all.

The six quality facets above are damped to 85 points between them, because the conditional facet above carries the other 15. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 85% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Show this score on your site.

It updates itself when the score changes. Paste this where you link to your API docs:

<a href="https://apis.io/providers/shaarli/"><img src="https://apis.io/badge/shaarli/card.svg" alt="Shaarli on APIs.io — Kin Score by API Evangelist"></a>

Other styles, a README pill and a shields.io endpoint are on the badge page.

Raise your score.

Agent readiness — checks not met, largest first (exact, from this profile):

MCP Server +12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship
Agentic Access Contract +10 pts — agentic_access artifact present (x-agentic-access), graded by author
Idempotency +9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented)
A2A Agent Card +8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0
Rate-Limit Signaling +7 pts — OpenAPI responses document X-RateLimit-* / RateLimit headers (verified), else a rate_limits artifact or RateLimits link (documented)
Request/Response Examples +7 pts — share of operations carrying request/response examples; else an Examples / Code Samples link

10 more unmet checks in the Agent Readiness table above.

Kin Score — facets with the most composite points still available (weight × headroom):

Contract Quality scores 9.4 — up to +22.7 composite points
Access Clarity scores 13.2 — up to +17.4 composite points
Developer Ergonomics scores 45.2 — up to +11.0 composite points

Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from the provider profile at artifacts.apis.io/shaarli/apis.yml: open an issue on github.com/api-evangelist/shaarli to ask a question or point us at an artifact you publish. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

APIs 2

Individual APIs this provider publishes, each with its own machine-readable definition.

Shaarli API

REST API for the Shaarli bookmarking service.

Shaarli API

Shaarli API as documented publicly: 2 operations. Contract generated from the documentation by API Evangelist (2026-10-28); not the provider's own document.

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

Shaarli API Rules

7 rules · 5 errors 1 warnings 1 info

SPECTRAL

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Shaarli Authentication

1 scheme

SECURITY

Shaarli Domain Security

TLSv1.3 · HSTS

SECURITY

Scopes 1

OAuth scopes governing access to this provider's APIs.

Shaarli Scopes

OAuth 2.0 · no documented scopes

0 scopes

SCOPES

Resources

Get Started 2

Portal, sign-up, and the first successful call

Login

GettingStarted

GettingStarted

Documentation 2

Reference material describing how the API behaves

Documentation

Documentation

APIReference

APIReference

Design & Contract 4

Pagination, idempotency, versioning, errors, and events

Spectral

Vocabulary

ErrorCatalog

Conformance

Build 1

SDKs, sample code, and the tooling you integrate with

GitHubOrganization

GitHubOrganization

Access & Security 2

Authentication, authorization, and security posture

Authentication

Authentication

DomainSecurity

DomainSecurity

Operate 2

Status, limits, changes, and where to get help

ChangeLog

ChangeLog

Support

Support

Company 1

The organization behind the API

Website

Website

Other 2

Properties that don't map to a standard resource type

Hosts

Hosts

Vendors

Vendors

Source (apis.yml)

aid: shaarli
name: Shaarli
image: https://raw.githubusercontent.com/shaarli/Shaarli/master/doc/md/images/doc-logo.png
description: Shaarli is an open‑source, self‑hosted bookmarking service that lets users store, tag, and share web links. Designed
  for personal use, it is minimalist, fast, and requires no database, using flat‑file storage instead. The project provides
  a web interface, a public demo instance, and a REST API for programmatic access. It is written in PHP, released under the
  MIT license, and can be deployed via Docker or traditional web servers. The community maintains documentation on Read the
  Docs and offers a client library ecosystem.
url: https://artifacts.apis.io/shaarli/apis.yml
x-type: company
x-source: harvest:new-submission
x-tier: profiled
x-tier-reason: enrichment pass 2026-10-28 (modular-v1; was harvest)
specificationVersion: '0.20'
created: '2026-10-28'
modified: '2026-10-28'
tags:
- Bookmarking
- Self-hosted
- Open-source
- PHP
- Minimalist
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
- FN: APIs.json
  email: info@apis.io
common:
- type: Spectral
  url: rules/shaarli-rules.yml
- type: Vocabulary
  url: vocabulary/shaarli-vocabulary.yml
- type: ChangeLog
  url: changelog/shaarli-changelog.yml
- type: Authentication
  url: authentication/shaarli-authentication.yml
- type: ErrorCatalog
  url: errors/shaarli-problem-types.yml
- type: Conformance
  url: conformance/shaarli-conformance.yml
- type: Hosts
  url: hosts/shaarli-hosts.yml
- type: Vendors
  url: vendors/shaarli-vendors.yml
- type: Login
  url: https://demo.shaarli.org/login
- type: DomainSecurity
  url: security/shaarli-domain-security.yml
- type: Website
  url: https://demo.shaarli.org
- type: Documentation
  url: https://shaarli.readthedocs.io
- type: APIReference
  url: https://shaarli.readthedocs.io/en/latest/REST-API.html
- type: GettingStarted
  url: https://shaarli.readthedocs.io/en/latest/Installation.html
- type: Support
  url: https://github.com/shaarli/Shaarli/issues
- type: GitHubOrganization
  url: https://github.com/shaarli
apis:
- name: Shaarli API
  description: REST API for the Shaarli bookmarking service.
  humanURL: https://shaarli.readthedocs.io/en/latest/REST-API.html
  baseURL: https://demo.shaarli.org
  aid: shaarli:shaarli-api-2
- aid: shaarli:shaarli-api
  name: Shaarli API
  description: 'Shaarli API as documented publicly: 2 operations. Contract generated from the documentation by API Evangelist
    (2026-10-28); not

    the provider''s own document.'
  humanURL: https://demo.shaarli.org/doc/html/Docker.html
  properties:
  - type: OpenAPI
    url: openapi/_ae-authored/shaarli-openapi-generated.yml
    x-provenance: generated
x-coverage:
  state: unreadable
  reason: no-machine-readable-spec
  detail: No OpenAPI/AsyncAPI/GraphQL spec found; only HTML docs and API requires authentication (401) on /api/v1/info.
  evidence:
  - url: https://api.shaarli.org/openapi.json
    status: 503
  - url: https://demo.shaarli.org/openapi.json
    status: 404
  checked: '2026-10-29'
x-submission-probe: 200, 2026-10-26
x-enrichment:
  date: '2026-10-28'
  status: nochange
  artifacts_added: 0
  pass: modular-v1
  engine: identity=oss,contract=oss,surfaces=oss,docs=oss,regulatory=oss

Shaarli API — frequently asked questions

Does Shaarli have an API?

Yes. APIs.io lists 2 APIs from Shaarli, including Shaarli API and Shaarli API.

Is there an OpenAPI specification for the Shaarli API?

Yes. APIs.io indexes 2 OpenAPI specifications for Shaarli, each linked for download from this page.

How do I authenticate with the Shaarli API?

Shaarli uses bearer-token authentication (1 scheme). The details are profiled on APIs.io as Shaarli Authentication.

Is the Shaarli API ready for AI agents?

Shaarli has a Kin Score of 28.5 out of 100 (thin) and an Agent Readiness score of 20.1 (agent-aware), scored by API Evangelist on 2026-10-31.

Work with this as data

Every provider here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This provider

curl "https://apis.io/api/v1/providers/shaarli"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/shaarli/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/shaarli/evidence"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.