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

# Start authentication

> Initiates an auth flow. Required fields depend on the provider:

| Provider | Required fields | Response type |
|----------|----------------|---------------|
| `google` | `redirectUrl` | `redirect` (OAuth URL) |
| `twitter` | `redirectUrl` | `redirect` (OAuth URL) |
| `email` | `email`, optionally `redirectUrl` | `magic_link` |
| `siwe` | *(none)* | `nonce` |
| `siws` | *(none)* | `nonce` |

When bot protection is active, wallet/email auth may return `challenge_required`. Render a Cloudflare Turnstile widget using the returned `siteKey` and resubmit with the resulting `turnstileToken`.



## OpenAPI

````yaml /openapi/openapi.json post /auth/start
openapi: 3.0.2
info:
  title: AGG API
  version: 1.0.0
  description: >-
    Prediction market aggregator REST API — authentication, users, venue events,
    venue markets, orderbooks, charts, and execution workflows.
servers:
  - url: https://api.agg.market
    description: Production
  - url: https://api.staging.agg.market
    description: Staging
security: []
paths:
  /auth/start:
    post:
      tags:
        - Authentication
      summary: Start authentication
      description: >-
        Initiates an auth flow. Required fields depend on the provider:


        | Provider | Required fields | Response type |

        |----------|----------------|---------------|

        | `google` | `redirectUrl` | `redirect` (OAuth URL) |

        | `twitter` | `redirectUrl` | `redirect` (OAuth URL) |

        | `email` | `email`, optionally `redirectUrl` | `magic_link` |

        | `siwe` | *(none)* | `nonce` |

        | `siws` | *(none)* | `nonce` |


        When bot protection is active, wallet/email auth may return
        `challenge_required`. Render a Cloudflare Turnstile widget using the
        returned `siteKey` and resubmit with the resulting `turnstileToken`.
      operationId: authStart
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - provider
              properties:
                provider:
                  type: string
                  enum:
                    - google
                    - twitter
                    - apple
                    - email
                    - siwe
                    - siws
                redirectUrl:
                  format: uri
                  type: string
                email:
                  format: email
                  maxLength: 254
                  type: string
                turnstileToken:
                  type: string
                earlyAccessCode:
                  type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                type: object
                required:
                  - type
                properties:
                  type:
                    type: string
                    enum:
                      - redirect
                      - magic_link
                      - nonce
                      - challenge_required
                  url:
                    type: string
                  success:
                    type: boolean
                    enum:
                      - true
                  nonce:
                    type: string
                  statement:
                    type: string
                  siteKey:
                    type: string
        '400':
          description: '400'
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                properties:
                  message:
                    type: string
        '401':
          description: '401'
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                properties:
                  message:
                    type: string
        '403':
          description: '403'
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                properties:
                  message:
                    type: string
        '429':
          description: '429'
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                properties:
                  message:
                    type: string
      security:
        - appId: []
components:
  securitySchemes:
    appId:
      type: apiKey
      in: header
      name: x-app-id
      description: Your application ID. Required for all app-tier and user-tier routes.

````