API reference · API keys

The key and the user it acts for

• Method: GET
• Path: /v1/me
• Operation ID: getMe
• Tags: Account

Needs only a valid key. Use it to check a key works and see what it can reach.

Make a request

Set these environment variables before running a sample. Each language reads the same values; no identifier needs replacing inside the code.

Variable	Value to supply
SHOWFM_API_KEY	Your API key. Keep it on your server.

Samples run on your server: curl 7.76+, Node.js 22+ (TypeScript via your TypeScript runner), Python 3, or PHP 8 with the cURL extension. Never put your API key in browser code.

curl

: "${SHOWFM_API_KEY:?Set SHOWFM_API_KEY in your environment}"

curl --fail-with-body --silent --show-error --get \
  "https://api.show.fm/v1/me" \
  --header "Authorization: Bearer ${SHOWFM_API_KEY}"

TypeScript

function env(name: string): string {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name} in your environment`);
  return value;
}

async function main() {
  const url = new URL(`https://api.show.fm/v1/me`);

  const response = await fetch(url, {
    headers: { Authorization: `Bearer ${env("SHOWFM_API_KEY")}` },
    signal: AbortSignal.timeout(30_000)
  });
  if (!response.ok) {
    throw new Error(`HTTP ${response.status}: ${await response.text()}`);
  }
  console.log(JSON.stringify(await response.json(), null, 2));
}

main().catch(error => {
  console.error(error);
  process.exitCode = 1;
});

JavaScript

function env(name) {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name} in your environment`);
  return value;
}

async function main() {
  const url = new URL(`https://api.show.fm/v1/me`);

  const response = await fetch(url, {
    headers: { Authorization: `Bearer ${env("SHOWFM_API_KEY")}` },
    signal: AbortSignal.timeout(30_000)
  });
  if (!response.ok) {
    throw new Error(`HTTP ${response.status}: ${await response.text()}`);
  }
  console.log(JSON.stringify(await response.json(), null, 2));
}

main().catch(error => {
  console.error(error);
  process.exitCode = 1;
});

Python

import os
import json
from urllib.parse import quote, urlencode
from urllib.request import Request, urlopen
from urllib.error import HTTPError

url = f'https://api.show.fm/v1/me'
request = Request(url, headers={
    "Authorization": "Bearer " + os.environ["SHOWFM_API_KEY"]
})
try:
    with urlopen(request, timeout=30) as response:
        print(json.dumps(json.load(response), indent=2))
except HTTPError as error:
    raise RuntimeError(f"HTTP {error.code}: {error.read().decode()}") from error

PHP

<?php
function requiredEnv(string $name): string {
    $value = getenv($name);
    if ($value === false || $value === '') {
        throw new RuntimeException("Set $name in your environment");
    }
    return $value;
}

$url = "https://api.show.fm" . "/v1/me";
$curl = curl_init($url);
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTPHEADER => ["Authorization: Bearer " . requiredEnv("SHOWFM_API_KEY")],
]);
$body = curl_exec($curl);
if ($body === false) {
    throw new RuntimeException(curl_error($curl));
}
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
if ($status < 200 || $status >= 300) {
    throw new RuntimeException("HTTP $status: $body");
}
echo json_encode(json_decode($body, false, 512, JSON_THROW_ON_ERROR), JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR) . PHP_EOL;

Base URL

• https://api.show.fm

Authentication

• apiKey: HTTP bearer

  An API key from Settings → API keys. showfm_live_ in production.

Responses

200304400401403429500503

Browse the documented response statuses, headers and body fields.

200 OK

Response headers

• RateLimit-Policy

  The bucket that applied, e.g. "account";q=60;w=60.

  string

• RateLimit

  Requests left and seconds to reset, e.g. "account";r=59;t=42.

  string

• ETag

  string

Response body

Content type: application/json

no additional properties

• data (required): Me

304 Not modified (matching If-None-Match).

This response has no body.

400, 401, 403, 500, 503

• 400 invalid_request: a bad parameter, or a key sent in the URL.
• 401 unauthorized (no Bearer key) or invalid_api_key.
• 403 forbidden: accept the current Terms in the app first.
• 500 internal_error. Retry; quote X-Request-Id if it persists.
• 503 service_unavailable. Retry shortly.

Response body

Content type: application/json

schema: Error, no additional properties

• error (required): object, no additional properties

  • code (required): string, possible values: "invalid_request", "not_found", "unavailable", "unauthorized", "invalid_api_key", "insufficient_scope", "forbidden", "plan_upgrade_required", "rate_limited", "service_unavailable", "internal_error", "not_implemented"

  • message (required): string

  • details: array

    Items:

    no additional properties

    • field (required): string

    • message (required): string

    • reason: string

      A stable reason a client may branch on, for example outside_retention.

  • docs_url: string

  • request_id: string

429 rate_limited. Wait for Retry-After seconds.

Response headers

• Retry-After

  integer

• RateLimit-Policy

  The bucket that applied, e.g. "account";q=60;w=60.

  string

• RateLimit

  Requests left and seconds to reset, e.g. "account";r=59;t=42.

  string

Response body

Content type: application/json

Uses the shared Error schema. View response fields.