> ## Documentation Index
> Fetch the complete documentation index at: https://juicer.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get account info, usage, and limits



## OpenAPI

````yaml /openapi/v1.yaml get /account
openapi: 3.1.0
info:
  title: Juicer API v1
  version: 1.0.0
  description: >
    The Juicer API provides two products under one API key:


    1. **Integration API** — Programmatically manage feeds, sources, posts, and
    moderation

    2. **Data API** — Query social posts for a handle or hashtag without
    creating a feed


    ## Authentication

    All requests require a Bearer token in the Authorization header:

    ```

    Authorization: Bearer jcr_your_api_key_here

    ```

    API keys can be created from the Developer page in the Juicer dashboard,

    **or** programmatically via `POST /v1/authorize` — see step 0 of the

    Quick Start below. No prior signup or dashboard access is required.


    ## Quick Start


    Create a feed, add a source, and get the embed code:


    ```bash

    # 0. Get an API key (no dashboard needed)

    curl -X POST https://api.juicer.io/v1/authorize \
      -H "Content-Type: application/json" \
      -d '{"email": "you@example.com", "client_name": "My Tool"}'
    # New email → returns `api_key` immediately (temporary until email
    confirmed).

    # Existing user → returns an `authorization_url` (user approves) and a

    # `poll_url`; GET the poll_url until it returns the `api_key`.


    # 1. Check your account

    curl https://api.juicer.io/v1/account \
      -H "Authorization: Bearer jcr_your_key"

    # 2. See available platforms

    curl https://api.juicer.io/v1/platforms \
      -H "Authorization: Bearer jcr_your_key"

    # 3. Create a feed

    curl -X POST https://api.juicer.io/v1/feeds \
      -H "Authorization: Bearer jcr_your_key" \
      -H "Content-Type: application/json" \
      -d '{"name": "My Brand Feed"}'

    # 4. Add a YouTube source

    curl -X POST https://api.juicer.io/v1/feeds/{feed_id}/sources \
      -H "Authorization: Bearer jcr_your_key" \
      -H "Content-Type: application/json" \
      -d '{"platform": "YouTube", "term": "NASA", "term_type": "username"}'

    # 5. Get embed code for your website

    curl https://api.juicer.io/v1/feeds/{feed_id}/embed \
      -H "Authorization: Bearer jcr_your_key"
    ```


    The embed endpoint returns ready-to-use snippets:


    - **JavaScript** — `<script>` tag for any website

    - **iframe** — For platforms that don't allow JavaScript

    - **WordPress shortcode** — `[juicer name='your-feed']`

    - **WordPress PHP** — `<?php juicer_feed('name=your-feed'); ?>`


    ## Discovering Platforms


    Use `GET /platforms` to see all available social media platforms and their

    supported term types (username, hashtag, mentions, etc.) before creating
    sources.

    Each term type includes its OAuth connection requirements, so you know
    upfront

    whether the user needs to connect an account first.


    ## Connecting Social Accounts


    Several platforms require a connected social account before you can create

    sources. The exact list and the per-term-type requirement depend on the

    caller's account configuration — always discover requirements at runtime

    from `GET /platforms` (the `requires_connection` field on each term type)

    or `GET /social_accounts/status`. The flow when a connection is needed:


    1. `GET /social_accounts/status` — check which platforms need connecting

    2. `POST /social_accounts/connect_url` with `{"provider": "facebook"}` —
    generates a magic link

    3. User clicks the link — it signs them in and starts the authorization flow
    (no Juicer login needed)

    4. `GET /social_accounts` — verify the account is now connected

    5. Create sources for that platform as normal


    The magic link expires in 30 minutes and can only be used once. This makes

    it suitable for AI agents and CLI tools that need to walk a user through

    social account setup.


    **Note:** If you try to create a source that requires a connected account

    and none is available, the API returns a `422` error with

    `error.code = "social_account_required"` and an `error.action` containing

    a magic link the user can click to complete the connection.


    ## Plan Limits


    Your plan determines how many feeds and sources you can create. If you hit

    a limit, the API returns a `422` error with `error.code =
    "feed_limit_reached"`

    or `"source_limit_reached"`, along with an `error.action` of type
    `"upgrade_plan"`

    that includes a magic link to the upgrade page with the correct plan
    pre-selected.
servers:
  - url: https://api.juicer.io/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Quickstart
    description: Get an API key with just an email, no dashboard required
  - name: Account
    description: Account info, usage, and limits
  - name: Platforms
    description: Discover available platforms and term types
  - name: Social Accounts
    description: Manage OAuth social account connections needed for certain platforms
  - name: Feeds
    description: Manage feeds (create, update, delete, list)
  - name: Sources
    description: Manage sources within feeds
  - name: Posts
    description: Read, search, and moderate posts
  - name: Embed
    description: Get embed code snippets for your website
  - name: Search
    description: Search posts across all feeds
  - name: Analytics
    description: Feed engagement analytics and performance
  - name: Webhooks
    description: Webhook subscriptions and event delivery
  - name: Data API
    description: One-off post lookups for a handle or hashtag without creating a feed
paths:
  /account:
    get:
      tags:
        - Account
      summary: Get account info, usage, and limits
      operationId: getAccount
      responses:
        '200':
          description: Account info
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Account'
components:
  schemas:
    Account:
      type: object
      properties:
        id:
          type: integer
        plan:
          type: string
          description: Internal plan name
        plan_display_name:
          type: string
          description: Human-readable plan name
        billing_cycle:
          type: object
          properties:
            start:
              type: string
              format: date
            end:
              type: string
              format: date
        usage:
          type: object
          properties:
            views:
              type: object
              properties:
                current:
                  type: integer
                limit:
                  type: integer
                  nullable: true
            feeds:
              type: object
              properties:
                current:
                  type: integer
                limit:
                  type: integer
            sources_per_feed_limit:
              type: integer
        features:
          type: object
          properties:
            api_enabled:
              type: boolean
            moderation:
              type: boolean
            mentions:
              type: boolean
        created_at:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        API key prefixed with `jcr_`. To obtain a key programmatically
        (no dashboard required), see `POST /v1/authorize`.

````