philidor-io Curators API

openapi: 3.2.0
info:
  title: Philidor Io Curators API
  version: 1.2.0
  description: 'Operations tagged Curators across 2 of this provider''s published API definitions: philidor-openapi.json, philidor-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.philidor.io
  description: Production
- url: http://localhost:3003
  description: Local
tags:
- name: Curators
paths:
  /v1/curators:
    get:
      tags:
      - Curators
      summary: List curators
      description: Paginated list of curators with aggregated TVL, vault count, and average APR.
      parameters:
      - schema:
          type: integer
          description: Page number (minimum 1)
          example: 1
        required: false
        name: page
        in: query
      - schema:
          type: integer
          description: Items per page (1–100)
          example: 20
        required: false
        name: limit
        in: query
      - schema:
          type: string
          description: 'Sort field: tvl_total, vault_count, avg_apr, name'
          example: tvl_total
        required: false
        name: sortBy
        in: query
      - schema:
          type: string
          description: 'Sort order: asc or desc'
          example: desc
        required: false
        name: sortOrder
        in: query
      - name: X-Request-Id
        in: header
        required: false
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,64}$
        description: Optional correlation id, echoed unchanged when valid; otherwise a UUID is generated.
      responses:
        '200':
          description: Curator list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CuratorListResponse'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
        '429':
          description: Rate limit exceeded; retry after Retry-After seconds
          headers:
            Retry-After:
              $ref: '#/components/headers/Retry-After'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
      - {}
      - ApiKeyAuth: []
      operationId: getV1Curators
    servers:
    - url: https://api.philidor.io
      description: Production
    - url: http://localhost:3003
      description: Local
  /v1/curators/{id}:
    get:
      tags:
      - Curators
      summary: Get curator by ID
      description: Curator detail including vaults, chain distribution, and events.
      parameters:
      - schema:
          type: string
          description: Curator ID
          example: gauntlet
        required: true
        name: id
        in: path
      - schema:
          type: string
          default: '1'
          description: Vault sub-resource page (minimum 1)
          example: '1'
        required: false
        name: vaultPage
        in: query
      - schema:
          type: string
          default: '50'
          description: Vaults per page (1–100)
          example: '50'
        required: false
        name: vaultLimit
        in: query
      - name: X-Request-Id
        in: header
        required: false
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,64}$
        description: Optional correlation id, echoed unchanged when valid; otherwise a UUID is generated.
      responses:
        '200':
          description: Curator detail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CuratorDetailResponse'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
        '429':
          description: Rate limit exceeded; retry after Retry-After seconds
          headers:
            Retry-After:
              $ref: '#/components/headers/Retry-After'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
      - {}
      - ApiKeyAuth: []
      operationId: getV1CuratorsId
    servers:
    - url: https://api.philidor.io
      description: Production
    - url: http://localhost:3003
      description: Local
  /v1/curators/{id}/events:
    get:
      tags:
      - Curators
      summary: Get curator events
      description: Paginated events for a curator, including vault-associated events.
      parameters:
      - schema:
          type: string
          description: Curator ID
          example: gauntlet
        required: true
        name: id
        in: path
      - schema:
          type: integer
          description: Offset for pagination
          example: 0
        required: false
        name: offset
        in: query
      - schema:
          type: integer
          description: Events per page
          example: 5
        required: false
        name: limit
        in: query
      - name: X-Request-Id
        in: header
        required: false
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,64}$
        description: Optional correlation id, echoed unchanged when valid; otherwise a UUID is generated.
      responses:
        '200':
          description: Curator events
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      events:
                        type: array
                        items:
                          $ref: '#/components/schemas/CuratorEvent'
                      total:
                        type: integer
                    required:
                    - events
                    - total
                required:
                - data
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
        '429':
          description: Rate limit exceeded; retry after Retry-After seconds
          headers:
            Retry-After:
              $ref: '#/components/headers/Retry-After'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
      - {}
      - ApiKeyAuth: []
      operationId: getV1CuratorsIdEvents
    servers:
    - url: https://api.philidor.io
      description: Production
    - url: http://localhost:3003
      description: Local
components:
  schemas:
    Curator:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        logo_url:
          type:
          - string
          - 'null'
        website:
          type:
          - string
          - 'null'
        one_liner:
          type:
          - string
          - 'null'
        created_at:
          type: string
        tvl_total:
          type: number
        vault_count:
          type: number
        avg_apr:
          type:
          - number
          - 'null'
      required:
      - id
      - name
      - logo_url
      - website
      - one_liner
      - created_at
      - tvl_total
      - vault_count
      - avg_apr
    CuratorDetailResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            curator:
              $ref: '#/components/schemas/Curator'
            vaults:
              type: array
              items: {}
            chainDistribution:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: number
                  name:
                    type: string
                  vault_count:
                    type: number
                  tvl:
                    type: number
                required:
                - id
                - name
                - vault_count
                - tvl
            events:
              type: array
              items: {}
            eventsTotal:
              type: number
            trackRecord:
              $ref: '#/components/schemas/CuratorTrackRecord'
          required:
          - curator
          - vaults
          - chainDistribution
          - events
          - eventsTotal
          - trackRecord
      required:
      - data
    CuratorListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Curator'
        meta:
          type: object
          properties:
            page:
              type: number
              description: The page parameter as received. Under offset paging (offset supplied) the offset takes precedence and meta.offset reports the row offset applied.
            limit:
              type: number
            total:
              type: number
            totalPages:
              type: number
            offset:
              type: number
              description: 'Present only when the request paged by offset: the row offset applied.'
          required:
          - page
          - limit
          - total
          - totalPages
      required:
      - data
      - meta
    CuratorTrackRecord:
      type: object
      properties:
        scoredVaultCount:
          type: number
          description: Active, non-shutdown vaults carrying a published score. Denominator for the dispersion below.
          example: 60
        scoreDispersion:
          type:
          - object
          - 'null'
          properties:
            worst:
              type: number
              example: 4.9
            p25:
              type: number
              example: 6.4
            median:
              type: number
              example: 7.35
            p75:
              type: number
              example: 8
            best:
              type: number
              example: 8.53
            spread:
              type: number
              description: best minus worst — how far apart the safest and riskiest vault in the book sit.
              example: 3.63
          required:
          - worst
          - p25
          - median
          - p75
          - best
          - spread
          description: 'Shape of the curator book, not an average. A mean hides the case this exists to show: a curator running one very safe vault and one poor one. Null when no vault is scored yet — never reported as zeros.'
        tierDistribution:
          type: array
          items:
            type: object
            properties:
              tier:
                type: string
                example: Core
              vaultCount:
                type: number
                example: 34
              tvlUsd:
                type: number
                example: 512300000
            required:
            - tier
            - vaultCount
            - tvlUsd
          description: Published tier mix, as counts and TVL rather than proportions.
        incidentHistory:
          type: object
          properties:
            total:
              type: number
              example: 3
            critical:
              type: number
              example: 1
            warning:
              type: number
              example: 2
            lossUsd:
              type:
              - number
              - 'null'
              description: Sum of recorded losses. Null when no incident carries a loss figure — distinct from a genuine zero.
            mostRecentAt:
              type:
              - string
              - 'null'
              example: '2026-07-17T00:00:00.000Z'
          required:
          - total
          - critical
          - warning
          - lossUsd
          - mostRecentAt
          description: Incidents on vaults this curator runs, whether or not the event is explicitly tagged to them. Attribution is mostly derived through the vault, because explicit curator tagging is sparse.
      required:
      - scoredVaultCount
      - scoreDispersion
      - tierDistribution
      - incidentHistory
    ErrorEnvelope:
      description: Error body. `legacy_code` is present for one compatibility release when an older endpoint previously emitted a lowercase route-specific code.
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          - request_id
          properties:
            code:
              type: string
              pattern: ^[A-Z][A-Z0-9_]*$
              example: NOT_FOUND
            message:
              type: string
              example: Vault not found
            request_id:
              type: string
              description: Correlation id, also in the X-Request-Id header.
            legacy_code:
              type: string
              description: Previous lowercase code during the one-release migration window.
            pricing_url:
              type: string
              description: Present on a tier gate. Same URL as refusal.upgrade_url.
            refusal:
              description: Present on 401/403 for a gated data family (PHI-312). Same object as one row of GET /v1/access/families. x402_price is null until pay-per-request is live.
              type: object
              required:
              - restricted_fields
              - family
              - required_plan
              - upgrade_url
              - x402_price
              properties:
                restricted_fields:
                  type: array
                  items:
                    type: string
                family:
                  type: string
                required_plan:
                  type:
                  - string
                  - 'null'
                  enum:
                  - Free
                  - Analyst
                  - Pro
                  - Data
                  - Decisioning
                  - Embedded
                  - null
                upgrade_url:
                  type: string
                  example: https://philidor.io/pricing
                x402_price:
                  type: 'null'
          additionalProperties: true
    CuratorEvent:
      type: object
      properties:
        id:
          type: integer
        vault_id:
          type:
          - string
          - 'null'
        vault_name:
          type:
          - string
          - 'null'
        curator_id:
          type:
          - string
          - 'null'
        protocol_id:
          type:
          - string
          - 'null'
        chain_id:
          type:
          - integer
          - 'null'
        event_type:
          type: string
        severity:
          type: string
        title:
          type: string
        description:
          type:
          - string
          - 'null'
        occurred_at:
          type: string
        detected_at:
          type:
          - string
          - 'null'
        status:
          type: string
        source:
          type:
          - string
          - 'null'
        provisional:
          type: boolean
        affects_tracked_universe:
          type: boolean
        incident_key:
          type:
          - string
          - 'null'
        loss_amount_usd:
          anyOf:
          - type: number
          - type: string
          - type: 'null'
        tx_hash:
          type:
          - string
          - 'null'
        links: {}
        data: {}
      required:
      - id
      - vault_id
      - vault_name
      - curator_id
      - protocol_id
      - chain_id
      - event_type
      - severity
      - title
      - description
      - occurred_at
      - detected_at
      - status
      - source
      - provisional
      - affects_tracked_universe
      - incident_key
      - loss_amount_usd
      - tx_hash
  headers:
    X-RateLimit-Limit:
      description: Requests allowed in the active window for this caller.
      schema:
        type: integer
    Retry-After:
      description: Seconds to wait before retrying (429, 503, 504).
      schema:
        type: integer
        minimum: 0
    X-RateLimit-Reset:
      description: Unix timestamp (seconds) when the window resets.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests remaining in the active window.
      schema:
        type: integer
    X-Request-Id:
      description: Correlation id for the request. A valid inbound X-Request-Id (1-64 word characters or dashes) is echoed; otherwise one is generated. Quote it when reporting a failure.
      schema:
        type: string
  securitySchemes:
    IndexTokenAuth:
      type: http
      scheme: bearer
      description: Separate index preview/client token. Commercial API keys do not unlock private index routes.
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: 'Philidor API key (`Authorization: Bearer pk_live_...`). Optional on public endpoints, where it raises rate limits and unlocks tiered capabilities. The administrative surfaces additionally require operator-set metadata.admin_surface=true; mutations require metadata.admin_role=admin_editor or admin_operator under the same write-role enforcement as admin sessions. A plan tier alone never grants administrative access.'
    AdminCookieAuth:
      type: apiKey
      in: cookie
      name: philidor_admin_session
      description: Administrative session. Additionally IP-allowlisted.
    DashboardCookieAuth:
      type: apiKey
      in: cookie
      name: philidor_dashboard_session
      description: Dashboard session cookie (httpOnly).
x-refined-from:
- philidor-openapi.json
- philidor-io-openapi.json