Skip to content
This repository has been archived by the owner on Jan 8, 2023. It is now read-only.
/ streamdeck-api Public archive

🌐 Serverless Stream Deck Store API & custom Shields.io & Badgen endpoints powered by Vercel ⯅

Notifications You must be signed in to change notification settings

tobimori/streamdeck-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

streamdeck-api

follow @tobimori on twitter Version number Open issues

Serverless Stream Deck Store API & custom Shields.io & Badgen endpoint powered by Next.js & Vercel

Schema

All API access happens over HTTPS, using GET requests and is accessed from https://streamdeck.api.moeritz.io/api/, that means that a usual call is a GET request to an url that may looks like https://streamdeck.api.moeritz.io/api/json/downloads/author/tobimori or similar urls. All content is served as JSON and cached server-side for an hour.

JSON

All API endpoints are available as a json version with full functionality.

https://streamdeck.api.moeritz.io/api/json/...

Shields.io

All API endpoints are also available as Shields.io custom endpoint.

https://img.shields.io/endpoint?url=https://streamdeck.api.moeritz.io/api/shields/...&style=...

An example url therefore would look like this:

https://img.shields.io/endpoint?url=https://streamdeck.api.moeritz.io/api/shields/downloads/com.elgato.counter

Which outputs:

Badgen

All API endpoints are also available as Badgen custom endpoint.

https://badgen.net/https/streamdeck.api.moeritz.io/api/badgen/...

An example url therefore would look like this:

https://badgen.net/https/streamdeck.api.moeritz.io/api/badgen/downloads/com.elgato.counter

Which outputs:

Endpoints

Download count of all plugins

/downloads/all

Example response

{
  "plugins": {
    "com.baptiewright.nanoleaf": 8906,
    "de.kaleidox.vbandeck": 3196,
    [...]
  },
  "totalDownloads": 2155526

The Shields.io & Badgen endpoints only return the total downloads.

Download count by plugin identifiers

/downloads/:pluginId/:secondPluginId/...

This endpoint supports multiple plugin identifiers to be seperated by a slash. An example plugin identifier is com.elgato.counter or de.tobimori.streamdeck.ifttt.

Example response

{
  "plugins": {
    "com.elgato.counter": 30482,
    "de.tobimori.streamdeck.ifttt": 14295,
    [...]
  },
  "totalDownloads": 71501
}

The Shields.io & Badgen endpoints only return the total downloads.

Download count by author

/downloads/author/:authorSlug

An example author slug is elgato or tobimori which is usually included in the plugin identifier.

Example response

{
  "plugins": {
    "com.elgato.counter": 30482,
    "com.elgato.cpu": 110937,
    [...]
  },
  "totalDownloads": 883703
}

The Shields.io & Badgen endpoints only return the total downloads.