swathapi-com Signup API

openapi: 3.2.0
info:
  title: Swath Signup API
  version: '1.0'
  description: 'Verified severe-weather intelligence. Swath detects hail storms from live NEXRAD/MRMS radar and damaging-wind events from measured NWS storm reports, builds verified damage swath polygons, and joins them against parcel data to answer: which properties were hit, and how hard. Authentication: every /v1 endpoint takes `Authorization: Bearer sk_...`. Self-serve keys via POST /v1/signup (free tier: 2 trial credits, 60 requests/min — paid plans from $35/mo). Credit costs per successful call: Swath Report (GET /v1/swaths/{id}/properties) = 1 credit per property returned plus 25 credits per record fetched fresh from the parcel vendor, 10-credit minimum; report quote (GET /v1/swaths/{id}/properties/quote) = 1 credit; property lookup (GET /v1/property) = 2 credits; billing endpoints = 0; everything else = 1 credit. Failed requests are never billed. Paid plans: developer (40,000 credits/mo) and scale (600,000 credits/mo) via POST /v1/billing/checkout.'
servers:
- url: https://swathapi.com
security:
- ApiKeyAuth: []
tags:
- name: Signup
paths:
  /v1/signup:
    post:
      operationId: create_account
      summary: 'Self-serve signup: email in, live free-tier API key out (no auth required)'
      description: Creates a free-tier account (2 trial credits) and returns a live API key. The api_key value is shown exactly once — only its hash is stored, so it must be saved immediately. Rate limited to 3 signups per IP per 24h.
      security: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - email
              properties:
                email:
                  type: string
                  description: Account email (one account per email)
                name:
                  type: string
                  description: Optional account name
      responses:
        '201':
          description: Account created — api_key appears only in this response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignupResult'
        '400':
          description: A valid email is required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: An account with this email already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Signup rate limit (3 per IP per 24h)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Signup
components:
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
              description: Machine-readable error code, e.g. invalid_request, unauthorized, credits_exhausted, rate_limited, not_found, account_exists, billing_not_configured
            message:
              type: string
            used:
              type: number
              description: Credits used this month (present on credits_exhausted)
            plan:
              type: string
              description: Current plan (present on credits_exhausted)
    SignupResult:
      type: object
      properties:
        account_id:
          type: string
        plan:
          type: string
          enum:
          - free
        monthly_credits:
          type: number
        api_key:
          type: string
          description: Live API key (sk_live_...) — shown exactly once, save it immediately
        docs:
          type: string
        quickstart:
          type: string
          description: Ready-to-run curl command using the new key
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: 'Swath API key, e.g. Authorization: Bearer sk_live_... Get one at POST /v1/signup or https://swathapi.com/signup'