> ## 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.

# Look up the canonical profile per platform for a handle

> Resolves one or more handles to their canonical profile on each
requested platform. Pass several handles as a comma-separated `term`
list — every term is looked up on every platform independently, and
each `data[]` entry is a `{ platform, term, exact_match, profiles[] }`
group. Hashtag terms (`#foo`) are rejected.

Every profile object includes every field and every `metrics` key;
any value not available for a given account is `null`. Do not assume a
field is always present — coverage varies by platform and account.

When a platform has an exact handle match, `profiles` holds that one
account (`exact_match: true`). Otherwise it holds best-effort candidate
matches for you to disambiguate (`exact_match: false`).

If one platform fails or has no result, others still return. Check
`meta.platforms` for per-platform status.




## OpenAPI

````yaml /openapi/v1.yaml get /data/profiles
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:
  /data/profiles:
    get:
      tags:
        - Data API
      summary: Look up the canonical profile per platform for a handle
      description: |
        Resolves one or more handles to their canonical profile on each
        requested platform. Pass several handles as a comma-separated `term`
        list — every term is looked up on every platform independently, and
        each `data[]` entry is a `{ platform, term, exact_match, profiles[] }`
        group. Hashtag terms (`#foo`) are rejected.

        Every profile object includes every field and every `metrics` key;
        any value not available for a given account is `null`. Do not assume a
        field is always present — coverage varies by platform and account.

        When a platform has an exact handle match, `profiles` holds that one
        account (`exact_match: true`). Otherwise it holds best-effort candidate
        matches for you to disambiguate (`exact_match: false`).

        If one platform fails or has no result, others still return. Check
        `meta.platforms` for per-platform status.
      operationId: getDataProfiles
      parameters:
        - name: term
          in: query
          required: true
          description: |
            One or more handles to resolve, comma-separated (no `#` hashtag
            prefix; `@` prefix allowed and stripped). Each handle is looked up
            on every requested platform. Up to 5 handles per request.
          schema:
            type: string
            example: juicer,juicerio,juicer.io
        - name: platforms
          in: query
          required: true
          description: |
            Comma-separated list of platforms. Supported: Bluesky, YouTube,
            LinkedIn, Pinterest, Twitter (X), Instagram, Facebook, TikTok.
            Unsupported names appear in `meta.platforms` with
            `error_code = "unknown_platform"`.
          schema:
            type: string
            example: Bluesky,YouTube,LinkedIn
      responses:
        '200':
          description: Profiles fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataProfilesResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
components:
  schemas:
    DataProfilesResponse:
      type: object
      required:
        - data
        - meta
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/DataProfileGroup'
        meta:
          type: object
          required:
            - total_results
            - platforms
          properties:
            total_results:
              type: integer
              description: Total profiles across all platform groups.
            platforms:
              type: array
              description: One entry per (platform, term) pair that was looked up.
              items:
                $ref: '#/components/schemas/ProfilePlatformStatus'
    DataProfileGroup:
      type: object
      description: Profiles resolved for a single (platform, term) pair.
      required:
        - platform
        - term
        - exact_match
        - profiles
      properties:
        platform:
          type: string
        term:
          type: string
          description: >-
            The handle this group was resolved for (one of the comma-separated
            `term` values).
        exact_match:
          type: boolean
          description: >
            true when the platform resolved an account whose handle equals the

            requested term. false when `profiles` is a best-effort candidate
            list.
        profiles:
          type: array
          description: >-
            The matching account when exact_match is true, otherwise candidate
            matches.
          items:
            $ref: '#/components/schemas/DataProfile'
    ProfilePlatformStatus:
      type: object
      description: Per-(platform, term) lookup status for the profile endpoint.
      required:
        - platform
        - term
        - success
      properties:
        platform:
          type: string
        term:
          type: string
        success:
          type: boolean
        count:
          type: integer
          description: Number of profiles returned for this pair (present on success).
        error_code:
          type: string
          enum:
            - unknown_platform
            - fetch_timeout
            - invalid_term
            - platform_error
        message:
          type: string
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: >
                Machine-readable error code. Possible values:

                - `unauthorized` — Missing or invalid API key

                - `forbidden` — API not enabled for account

                - `not_found` — Resource not found

                - `parameter_missing` — Required parameter not provided

                - `validation_failed` — Model validation failed (see `details`)

                - `feed_limit_reached` — Plan's feed limit exceeded (see
                `action`)

                - `source_limit_reached` — Feed's source limit exceeded (see
                `action`)

                - `user_limit_reached` — Plan doesn't include team members (see
                `action`)

                - `social_account_required` — OAuth connection needed (see
                `action`)

                - `invalid_platform` — Platform not supported

                - `invalid_provider` — Unknown OAuth provider

                - `invalid_status` — Invalid post status filter

                - `invalid_action_type` — Invalid bulk moderation action

                - `query_required` — Search query not provided
              example: feed_limit_reached
            message:
              type: string
              description: Human-readable error message
              example: Your Free plan allows 1 feed(s). Upgrade to create more.
            details:
              type: object
              nullable: true
              description: >-
                Field-level validation errors. Present when `code` is
                `validation_failed`.
              additionalProperties:
                type: array
                items:
                  type: string
              example:
                name:
                  - can't be blank
            action:
              nullable: true
              description: >
                Actionable fix for the error. Present when the error can be
                resolved

                by the user taking a specific action (upgrading plan or
                connecting a social account).

                The `type` field tells you what kind of action is needed.
              oneOf:
                - $ref: '#/components/schemas/UpgradePlanAction'
                - $ref: '#/components/schemas/ConnectSocialAccountAction'
    DataProfile:
      type: object
      description: Normalized profile returned by the Data API.
      required:
        - platform
        - metrics
      properties:
        platform:
          type: string
        platform_id:
          type: string
          nullable: true
        handle:
          type: string
          nullable: true
        display_name:
          type: string
          nullable: true
        url:
          type: string
          nullable: true
        image:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        verified:
          type: boolean
          nullable: true
        metrics:
          $ref: '#/components/schemas/DataProfileMetrics'
    UpgradePlanAction:
      type: object
      description: >
        Returned when a plan limit is hit (feed limit, source limit).

        The `upgrade_url` is a magic link — the user clicks it, gets signed in

        automatically, and lands on the upgrade page with the right plan
        pre-selected.
      properties:
        type:
          type: string
          enum:
            - upgrade_plan
        current_plan:
          type: string
          example: small
        current_plan_display_name:
          type: string
          example: Free
        required_plan:
          type: string
          description: The minimum plan that unlocks this feature
          example: large
        required_plan_display_name:
          type: string
          example: Pro
        upgrade_url:
          type: string
          description: >-
            Magic link — signs user in and redirects to the upgrade page.
            Expires in 30 minutes.
        expires_at:
          type: string
          format: date-time
    ConnectSocialAccountAction:
      type: object
      description: >
        Returned when a source requires an OAuth-connected social account.

        The `connection_url` is a magic link — the user clicks it, gets signed
        in

        automatically, and starts the OAuth authorization flow.
      properties:
        type:
          type: string
          enum:
            - connect_social_account
        provider:
          type: string
          description: OAuth provider to connect
          example: facebook
        connection_url:
          type: string
          description: >-
            Magic link — signs user in and starts OAuth flow. Expires in 30
            minutes.
        expires_at:
          type: string
          format: date-time
    DataProfileMetrics:
      type: object
      description: Profile metrics. Any value not available for an account is null.
      properties:
        follower_count:
          type: integer
          nullable: true
        post_count:
          type: integer
          nullable: true
        total_view_count:
          type: integer
          nullable: true
          description: Lifetime view count across all of the account's posts.
        avg_views_per_post:
          type: integer
          nullable: true
          description: Mean views per post (total_view_count / post_count).
        language:
          type: string
          nullable: true
          description: Locale string for the account's content.
        location:
          type: string
          nullable: true
          description: >-
            Location associated with the account (city, country, region) —
            free-text, not an ISO country code.
        recent_post_engagement:
          type: object
          nullable: true
          description: >-
            Engagement counts from one recent post, for computing an engagement
            rate.
          properties:
            likes:
              type: integer
              nullable: true
            comments:
              type: integer
              nullable: true
            shares:
              type: integer
              nullable: true
            views:
              type: integer
              nullable: true
            sampled_post_url:
              type: string
              nullable: true
            sampled_post_created_at:
              type: string
              format: date-time
              nullable: true
              description: >-
                ISO-8601 timestamp of the sampled post. Null when no post
                timestamp is available.
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    UnprocessableEntity:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        API key prefixed with `jcr_`. To obtain a key programmatically
        (no dashboard required), see `POST /v1/authorize`.

````