Quick start

The Loomkeep API gives read access to your own account: your library across video, games, books and music, your history, lists, upcoming episodes, stats, reviews, profile, notifications and a full data export. It is plain JSON over HTTPS, and every request carries a personal API key you create yourself.

1. Create a key. In Loomkeep, open Settings › Integrations and create an API key. Grant it only the resources your tool needs, then copy it: it is shown once.

2. Check it. GET /v1/me works with any key and says which account and key you are using, and your rate limit.

   curl

   curl -H "Authorization: Bearer $LOOMKEEP_API_KEY" \
     https://loomkeep.app/api/v1/me

   JavaScript

   const res = await fetch("https://loomkeep.app/api/v1/me", {
     headers: { Authorization: `Bearer ${process.env.LOOMKEEP_API_KEY}` },
   });
   console.log(await res.json());

   Python

   import os
   import requests
   
   res = requests.get(
       "https://loomkeep.app/api/v1/me",
       headers={"Authorization": f"Bearer {os.environ['LOOMKEEP_API_KEY']}"},
   )
   print(res.json())

3. Read your library. With library:read, GET /v1/library lists what you track, newest first. Keep what is under way with ?phase=IN_PROGRESS:

   curl -H "Authorization: Bearer $LOOMKEEP_API_KEY" \
     "https://loomkeep.app/api/v1/library?phase=IN_PROGRESS&limit=5"

4. Go further. Every endpoint is in the reference, where you can try them with your key. The recipes show ready-made uses.

Self-hosted?

Use your own address: https://<your-instance>/api/v1. Each instance also serves the exact contract it runs at /api/v1/openapi.json.

Next

• Authentication: keys, scopes and their lifetime.
• Concepts: works, entries, statuses and history.
• Conventions: formats, pagination and languages.