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

# Generate a social provider OAuth URL

> Returns the provider authorization URL the client should redirect the user to. Currently only `GOOGLE` is accepted. The signed `state` is stored server-side and must be echoed back to `/auth/social/verify`.



## OpenAPI

````yaml https://mcp.echozero.app/api/docs-json post /api/auth/social/url
openapi: 3.0.0
info:
  title: EchoZero MCP API
  description: >-
    EchoZero MCP Server - Developer API for agent management, trading,
    marketplace, and AI chat.


    **Rate Limiting:** All endpoints enforce per-API-key rate limits. Tiers:
    free (60 req/min), standard (300 req/min), premium (1000 req/min). Every
    response includes `X-RateLimit-Limit`, `X-RateLimit-Remaining`,
    `X-RateLimit-Reset` headers. Exceeding the limit returns `429 Too Many
    Requests` with a `Retry-After` header.
  version: '1.0'
  contact: {}
servers:
  - url: https://mcp.echozero.app
    description: Production
security: []
tags:
  - name: MCP Protocol
    description: >-
      Model Context Protocol (Streamable HTTP): `/mcp`, `/mcp/sse` — not under
      `/api`; same API key as REST
  - name: Health
    description: Server health check
  - name: API Keys
    description: API key generation, listing, and revocation
  - name: User
    description: >-
      User profile, sessions, social, onboarding, internal agent subscriptions,
      and bot activations (v1: /v1/users/me)
  - name: Token
    description: Token data and trending
  - name: Trade
    description: Trade execution and history
  - name: Strategy
    description: Strategy (trading bot) configuration and control
  - name: Agent
    description: Agent registration and management
  - name: AI
    description: AI chat, intent, and insights
  - name: Wallet
    description: Wallet operations, deposits, and withdrawals
  - name: Notification
    description: Notification management and settings
  - name: Auth
    description: >-
      Public authentication: signup / login lookup, code verification, Google
      OAuth, refresh, and sign-out. Returns `accessToken` / `refreshToken` in
      the JSON body.
  - name: OAuth
    description: >-
      OAuth 2.1 authorization-code + PKCE for AI assistant clients:
      `/oauth/authorize`, `/oauth/token`, `/oauth/introspect`, `/status`.
  - name: Activity
    description: User trade activity list and search
  - name: Feed
    description: Social activity feed timeline
  - name: Earn
    description: Leaderboard, rewards, and referrals
  - name: Statics
    description: Countries, languages, and static data
  - name: Misc
    description: File uploads and utility endpoints
  - name: Developer
    description: Developer registration and profile
  - name: Developer dashboard
    description: >-
      Per-agent dashboard: subscribers (anonymized), performance detail, signal
      history (v1)
  - name: Developer Agent
    description: Developer agent listings and management
  - name: Developer Agents (Marketplace)
    description: Public browse, search, and subscribe to external developer-listed agents
  - name: Admin
    description: Admin-only endpoints for review, approval, and platform management
  - name: Webhooks
    description: >-
      Inbound provider webhooks (no API key). Telegram signal-bot uses
      `X-Telegram-Bot-Api-Secret-Token` when configured.
paths:
  /api/auth/social/url:
    post:
      tags:
        - Auth
      summary: Generate a social provider OAuth URL
      description: >-
        Returns the provider authorization URL the client should redirect the
        user to. Currently only `GOOGLE` is accepted. The signed `state` is
        stored server-side and must be echoed back to `/auth/social/verify`.
      operationId: McpAuthController_authWithSocial
      parameters:
        - name: x-signature
          in: header
          required: false
          description: >-
            HMAC-SHA256 signature: HMAC-SHA256(secretKey, timestamp + METHOD +
            path + body). Optional -- when omitted, HMAC verification is
            skipped.
          schema:
            type: string
        - name: x-timestamp
          in: header
          required: false
          description: >-
            Request timestamp in epoch milliseconds. Required when x-signature
            is provided. Rejected if drift exceeds 5 minutes.
          schema:
            type: string
      requestBody:
        required: true
        description: >-
          OpenAPI schema **McpAuthWithSocialBodyDto**. Subset of GraphQL
          `AuthWithSocialInput` restricted to Google.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/McpAuthWithSocialBodyDto'
            examples:
              minimal:
                summary: Google OAuth URL (minimal)
                value:
                  type: GOOGLE
                  fingerprint: fp_browser_abc123
              fullAllFields:
                summary: Google OAuth URL (all fields)
                description: >-
                  All optional metadata -- picked up only when this flow results
                  in a new user.
                value:
                  type: GOOGLE
                  fingerprint: fp_browser_abc123
                  redirectPath: /dashboard
                  receiveMarketingOffers: true
                  promoCode: WELCOME2025
                  referrerUsername: referrer_user
                  referrerUserId: 507f1f77bcf86cd799439011
      responses:
        '200':
          description: OAuth URL generated.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/McpSuccessResponseDto'
                  - properties:
                      data:
                        $ref: >-
                          #/components/schemas/McpGenerateSocialAuthUrlResponseDto
        '400':
          description: Validation error or unsupported provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/McpErrorResponseDto'
components:
  schemas:
    McpAuthWithSocialBodyDto:
      type: object
      properties:
        type:
          type: string
          enum:
            - GOOGLE
            - FACEBOOK
            - APPLE
            - TWITTER
            - DISCORD
            - TELEGRAM
          description: >-
            Social provider. Only `GOOGLE` is currently exposed on the MCP REST
            API.
          example: GOOGLE
        fingerprint:
          type: string
          description: Device fingerprint / visitor id.
          example: fp_browser_abc123
        redirectPath:
          type: string
          description: Frontend path the client wants to land on after OAuth verification.
          example: /dashboard
        receiveMarketingOffers:
          type: boolean
          description: >-
            Opt-in to marketing offers / communications (applied only if this
            flow creates a new user).
        promoCode:
          type: string
          description: Promo code (new users only).
        referrerUsername:
          type: string
          description: Username of the referring user (new users only).
        referrerUserId:
          type: string
          description: User id of the referring user (new users only).
          example: 507f1f77bcf86cd799439011
      required:
        - type
        - fingerprint
    McpSuccessResponseDto:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          type: object
          description: Endpoint-specific payload
          additionalProperties: true
      required:
        - success
        - data
    McpGenerateSocialAuthUrlResponseDto:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
            - error
        url:
          type: string
          description: >-
            Provider-specific OAuth URL. Open in the user's browser; the
            provider will redirect back to the configured callback with `code`
            and `state`.
        errorMessage:
          type: string
      required:
        - status
    McpErrorResponseDto:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          $ref: '#/components/schemas/McpErrorBodyDto'
      required:
        - success
        - error
    McpErrorBodyDto:
      type: object
      properties:
        code:
          type: string
          example: NOT_FOUND
        message:
          type: string
          example: Resource not found
      required:
        - code
        - message

````