Local Selections Groups API

The Groups API from Local Selections — 2 operation(s) for groups.

GitHub OpenAPI

Operations 2

POST /groups Create (host) a group decision session #
POST /groups/join Join a group decision session by join code #

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API
curl "https://apis.io/api/v1/apis/localselections-com:localselections-com-groups-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

localselections-com-groups-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: LocalSelections Public Groups API
  version: 1.6.0
  description: 'The public REST surface for LocalSelections'' decision engine — the same shared foundation an MCP server and chat-bot integrations sit on top of (PROJECT_OVERVIEW.md section 3.6). Every endpoint below is a thin wrapper around the same internal logic the browser app itself calls; authenticate with a per-caller API key, not a browser session. Keys are issued by application (Stage 311): a new key starts pending and works only after LocalSelections approves it (12 months), and the application must show "Powered by LocalSelections" linked to localselections.com on its registered public URL, which is checked weekly. Every response is `Cache-Control: no-store` and carries an `X-LocalSelections-Terms` header naming the terms. Each key carries one or more scopes minted at creation time via /account/api-keys — one real scope per endpoint (`spin`, `search`, `surprise_me`, `bracket`, `groups_host`, `groups_join`, `places`, `events`, `movies`), or the superset `all` — an out-of-scope call gets a 403, not a silent failure. Rate limits are tiered by the key owner''s subscription status (10 units/60s free, 120 units/60s subscribed; Stage 311) and cost-weighted per endpoint rather than a flat 1 per call — see each path and the 429 response for its real cost. Call GET /introspect at any time to see a key''s real current scopes, rate-limit usage, and commercial status without spending any of its budget. Keys minted before this per-endpoint scope model shipped (Stage 104) were migrated in place to the equivalent new scope(s), so no pre-existing key lost or gained access. Stage 196 added /places, /events, and /movies — direct, freeform read access to the same real local-data sources (Places, events, TMDB) the game mechanics above already narrow to a single pick, each result carrying a `detailUrl` to a real, permanent LocalSelections page when one exists, for a caller/agent that wants to link back to us rather than just narrate a result. Stage 198: because those three endpoints expose the real underlying database rather than a narrowed pick, non-commercial use of them is additionally capped by a per-key daily ceiling (50/40/75 calls per day for places/events/movies on a free key, the original 100/80/150 for a subscribed one; Stage 311 — a 429 with `error: "daily_limit_exceeded"`, distinct from the shared per-minute rate_limited response) — commercial use (primary purpose is revenue for the caller, mirroring how TMDB itself defines commercial use) requires contacting us directly for a paid license before a key is upgraded out of the free tier; `api_keys.commercial` (admin-set only, never self-service) governs the exemption. Use of this API is governed by the API Terms of Use (termsOfService below) — attribution, no caching/storing/redistributing/reselling data beyond a single request-response use, and immediate revocation on violation. Place data notices (Stage 234): the /places data comes from Overture Maps (Overture Maps Foundation, overturemaps.org) and includes Foursquare OS Places records licensed under Apache 2.0 — Foursquare''s NOTICE.txt text, the Overture source list and our notice of changes are reproduced in section 8 of the API Terms and on /legal. Chicago event data (Chicago Park District outdoor event permits, City of Chicago Data Portal): This site provides applications using data that has been modified for use from its original source, www.cityofchicago.org, the official website of the City of Chicago. The City of Chicago makes no claims as to the content, accuracy, timeliness, or completeness of any of the data provided at this site. The data provided at this site is subject to change at any time. It is understood that the data provided at this site is being used at one’s own risk. Full notice: https://localselections.com/legal'
  termsOfService: https://localselections.com/api-terms
servers:
- url: /api/v1
  description: Relative to whichever host this spec was fetched from.
security:
- ApiKeyAuth: []
tags:
- name: Groups
paths:
  /groups:
    post:
      summary: Create (host) a group decision session
      description: Requires the `groups_host` scope, and requires the API key owner to have an active subscription — the identical gate the browser's group-hosting flow enforces (PROJECT_OVERVIEW.md section 3.2), re-checked at the database layer, not just here. A key can be scoped to host without also being able to join (`groups_join` is a separate scope) or vice versa. Costs 1 unit of the key's rate-limit budget per call.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                categoryMode:
                  type: string
                  enum:
                  - cuisine
                  - activity
                  default: cuisine
                mechanic:
                  type: string
                  enum:
                  - wheel
                  - dice
                  - rps
                  - coinflip
                  - carddraw
                  - magic8ball
                  default: wheel
                displayName:
                  type: string
                  default: API host
      responses:
        '200':
          description: The created group session and its join code.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  joinCode:
                    type: string
                  categoryMode:
                    type: string
                  mechanic:
                    type: string
                  status:
                    type: string
                required:
                - id
                - joinCode
                - categoryMode
                - mechanic
                - status
        '400':
          description: The request body failed validation.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                - error
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                - error
        '403':
          description: Either the key lacks the "groups_host" scope, or its owner does not have an active subscription — the message field distinguishes the two (insufficient_scope vs. subscription_required).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                - error
        '429':
          description: 'Rate limit exceeded for this API key. The budget is 10 units/60s for keys owned by an unsubscribed account (30 before Stage 311), 120 units/60s for a subscribed account''s keys (Stage 60) — shared across every endpoint, but each endpoint spends a different number of units per call rather than always 1 (Stage 104): search/groups_host/groups_join/places/movies cost 1, surprise_me/events cost 2, spin costs 3, bracket costs 4. Call GET /introspect to see a key''s real remaining budget before it runs out.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                - error
        '502':
          description: An upstream data source failed or returned nothing usable.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                - error
      tags:
      - Groups
      operationId: postGroups
      x-operation-id-source: derived
  /groups/join:
    post:
      summary: Join a group decision session by join code
      description: Requires the `groups_join` scope — no subscription required, same as an anonymous browser join-by-code. A key can be scoped to join without also being able to host (`groups_host` is a separate scope) or vice versa. Costs 1 unit of the key's rate-limit budget per call.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                joinCode:
                  type: string
                displayName:
                  type: string
                  default: API participant
              required:
              - joinCode
      responses:
        '200':
          description: The joined session id and this caller's participant identity.
          content:
            application/json:
              schema:
                type: object
                properties:
                  sessionId:
                    type: string
                  clientId:
                    type: string
                  displayName:
                    type: string
                required:
                - sessionId
                - clientId
                - displayName
        '400':
          description: The request body failed validation.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                - error
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                - error
        '403':
          description: The API key does not carry the scope this endpoint requires (see the "Requires the ... scope" note on each path, or call GET /introspect to see a key's real granted scopes).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                - error
        '404':
          description: No group session exists for that join code.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                - error
        '429':
          description: 'Rate limit exceeded for this API key. The budget is 10 units/60s for keys owned by an unsubscribed account (30 before Stage 311), 120 units/60s for a subscribed account''s keys (Stage 60) — shared across every endpoint, but each endpoint spends a different number of units per call rather than always 1 (Stage 104): search/groups_host/groups_join/places/movies cost 1, surprise_me/events cost 2, spin costs 3, bracket costs 4. Call GET /introspect to see a key''s real remaining budget before it runs out.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                - error
      tags:
      - Groups
      operationId: postGroupsJoin
      x-operation-id-source: derived
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'A per-caller API key issued via the authenticated (browser-session) POST /api/account/api-keys endpoint. `Authorization: Bearer <key>` is also accepted as an alternative to the X-API-Key header. Each key carries scopes (`all`, or one or more of `spin`/`search`/`surprise_me`/`bracket`/`groups_host`/`groups_join`/`places`/`events`/`movies`) that gate which paths below it may call — see each path''s description for its required scope, or GET /introspect to check a key''s real scopes directly.'