EdgeDepth API

openapi: 3.1.0
info:
  title: EdgeDepth API
  version: '2026-11-06'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-06: 10 operation(s) read from 6 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; EdgeDepth has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 2
    documentation: 8
    pages-with-code: 2
    pages-read: 6
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-06'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://edgedepth.com/research/api
  - https://edgedepth.com/research/api/auth
  - https://edgedepth.com/research/api/credits
  - https://edgedepth.com/research/api/grammar
  - https://edgedepth.com/research/api/examples
  - https://edgedepth.com/research/symbols/0gusdt
servers:
- url: https://app.edgedepth.com
paths:
  /api/research/reports:
    get:
      operationId: get_api_research_reports
      tags:
      - Api
      summary: Machine‑readable index of published reports touching the symbol.
      x-source: https://edgedepth.com/research/symbols/0gusdt
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/research/query:
    post:
      operationId: post_api_v1_research_query
      tags:
      - Api
      summary: Four query examples.
      x-source: https://edgedepth.com/research/api/examples
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1ResearchQueryRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1ResearchQueryResponse'
      x-evidence:
        kind: documentation
  /api/v1/research/registry:
    get:
      operationId: get_api_v1_research_registry
      tags:
      - Api
      summary: Read the registry – the live, closed list of everything a query may say.
      x-source: https://edgedepth.com/research/api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1ResearchRegistryResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_v1_research_registry
      tags:
      - Api
      summary: POST /api/v1/research/registry
      x-source: https://edgedepth.com/research/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1ResearchRegistryRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -s https://app.edgedepth.com/api/v1/research/registry  -H "Authorization: Bearer edk_live_YOUR_KEY" 3. Review the scope
          and run one scan The request body is a research_query.v2 document: stated conditions only, fail-closed validation, named error codes.
          This one asks: on 3 majors over 7 days, where was VPIN at or above 0.7? These fixed dates are an example, not a claim about the latest
          covera'
  /api/v1/research/snapshot:
    get:
      operationId: get_api_v1_research_snapshot
      tags:
      - Api
      summary: Point at a moment and read the registry as-of that bucket.
      x-source: https://edgedepth.com/research/api/examples
      parameters:
      - name: symbol
        in: query
        required: true
        schema:
          type: string
      - name: t
        in: query
        required: true
        schema:
          type: string
        description: ISO‑8601 timestamp
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1ResearchSnapshotResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_v1_research_snapshot
      tags:
      - Api
      summary: POST /api/v1/research/snapshot
      x-source: https://edgedepth.com/research/api/examples
      parameters:
      - name: symbol
        in: query
        required: false
        schema:
          type: string
      - name: t
        in: query
        required: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1ResearchSnapshotRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -s "https://app.edgedepth.com/api/v1/research/snapshot?symbol=ethusdt&t=2026-07-14T18:05:00Z"  -H "Authorization: Bearer
          edk_live_YOUR_KEY" The snapshot is a cacheable artifact with its own reproducibility headers; it never executes a query. Selection discipline
          still applies: if you picked the moment BECAUSE it moved, the follow-up scan is the corrective - expect the pattern to deflate over '
  /api/v1/research/strategies/catalog:
    get:
      operationId: get_api_v1_research_strategies_catalog
      tags:
      - Api
      summary: Read GET /api/v1/research/strategies/catalog for the qualified source revision and markets.
      x-source: https://edgedepth.com/research/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/research/strategies/estimate:
    post:
      operationId: post_api_v1_research_strategies_estimate
      tags:
      - Api
      summary: Send POST /api/v1/research/strategies/estimate {document}.
      x-source: https://edgedepth.com/research/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1ResearchStrategiesEstimateRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1ResearchStrategiesEstimateResponse'
      x-evidence:
        kind: documentation
  /api/v1/research/strategies/run:
    post:
      operationId: post_api_v1_research_strategies_run
      tags:
      - Api
      summary: After explicit approval, send POST /api/v1/research/strategies/run {document,confirmation,attempt,units,name} with those unchanged
        values.
      x-source: https://edgedepth.com/research/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1ResearchStrategiesRunRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1ResearchStrategiesRunResponse'
      x-evidence:
        kind: documentation
  /interpret:
    post:
      operationId: post_interpret
      tags:
      - Interpret
      summary: research:interpret the natural-language proposer (POST /interpret).
      description: Calls the interpret endpoint which requires the `research:interpret` scope. The request body contains a natural‑language query
        (not detailed on the page).
      x-source: https://edgedepth.com/research/api/auth
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiV1ResearchQueryRequest:
      type: object
      properties:
        schema_version:
          type: string
        normalization_version:
          type: string
        feature_version:
          type: string
        target:
          type: string
        where:
          type: object
        sequence:
          type: object
        sort:
          type: array
        page:
          type: object
      required:
      - schema_version
      - normalization_version
      - feature_version
      - target
    PostApiV1ResearchQueryResponse:
      type: object
      properties:
        counts:
          type: object
        outcomes_summary:
          type: object
        rows:
          type: array
        cursor:
          type: string
    GetApiV1ResearchRegistryResponse:
      type: object
      properties:
        features:
          type: array
          description: Feature ids available for queries.
        operators:
          type: array
          description: Supported operators.
        window_aggregates:
          type: array
          description: Window aggregate definitions.
        sequence_rules:
          type: array
          description: Sequence rule definitions.
        limits:
          type: object
          description: Limits and error codes.
    PostApiV1ResearchRegistryRequest:
      type: object
      properties:
        schema_version:
          type: string
        normalization_version:
          type: string
        feature_version:
          type: string
        target:
          type: string
        where:
          type: object
          properties:
            all:
              type: array
              items:
                type: array
                items:
                  type: string
        sort:
          type: array
          items:
            type: string
        page:
          type: object
          properties:
            limit:
              type: integer
            cursor:
              type:
              - string
              - 'null'
    GetApiV1ResearchSnapshotResponse:
      type: object
      properties:
        features:
          type: object
        window_aggregates:
          type: object
        fired_rulebook_ids:
          type: array
    PostApiV1ResearchSnapshotRequest:
      type: object
      properties:
        language:
          type: string
    PostApiV1ResearchStrategiesEstimateRequest:
      type: object
      properties:
        document:
          type: object
          description: The strategy definition document.
      required:
      - document
    PostApiV1ResearchStrategiesEstimateResponse:
      type: object
      properties:
        definition:
          type: object
          description: Returned definition.
        confirmation:
          type: string
          description: Confirmation token.
        attempt:
          type: string
          description: Attempt identifier.
        allowance_units:
          type: integer
          description: Allowance units required.
    PostApiV1ResearchStrategiesRunRequest:
      type: object
      properties:
        document:
          type: object
          description: The strategy definition document.
        confirmation:
          type: string
          description: Confirmation token from estimate.
        attempt:
          type: string
          description: Attempt identifier from estimate.
        units:
          type: integer
          description: Allowance units.
        name:
          type: string
          description: Name for the run.
      required:
      - document
      - confirmation
      - attempt
      - units
      - name
    PostApiV1ResearchStrategiesRunResponse:
      type: object
      properties:
        job_id:
          type: string
          description: Identifier to poll for progress.
        result_id:
          type: string
          description: Identifier to retrieve the immutable full result.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Interpret