Barker Money API

openapi: 3.1.0
info:
  title: Barker Money API
  version: '2026-11-02'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-02: 9 operation(s) read from 7 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Barker Money has published no machine-readable contract that
    the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 5
    documentation: 4
    pages-with-code: 4
    pages-read: 7
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-02'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.barker.money/contracts-reference.md
  - https://docs.barker.money/webhooks.md
  - https://docs.barker.money/quickstart.md
  - https://docs.barker.money/integration-api.md
  - https://github.com/openapi-ts/openapi-typescript/issues/2864
  - https://github.com/openapi-ts/openapi-typescript/issues/2878/linked_closing_reference?reference_location=REPO_PULLS_INDEX
  - https://github.com/openapi-ts/openapi-typescript/issues/2865/linked_closing_reference?reference_location=REPO_PULLS_INDEX
servers:
- url: https://api.barker.money
paths:
  /:
    post:
      operationId: post
      tags:
      - Api
      summary: POST /
      x-source: https://github.com/openapi-ts/openapi-typescript/issues/2878/linked_closing_reference?reference_location=REPO_PULLS_INDEX
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: javascript
        snippet: 'fetch ( "https://example.com" , { method : "POST" , body : formData } )'
  /api/partner/products:
    get:
      operationId: get_api_partner_products
      tags:
      - Api
      summary: The engine address is per-partner, returned by GET /api/partner/products as engine_contract_address.
      x-source: https://docs.barker.money/contracts-reference.md
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiPartnerProductsResponse'
      x-evidence:
        kind: documentation
  /api/partner/products/${product.slug}/position:
    get:
      operationId: get_api_partner_products_product_slug_position
      tags:
      - Api
      summary: GET /api/partner/products/${product.slug}/position
      x-source: https://docs.barker.money/integration-api.md
      parameters:
      - name: product.slug
        in: path
        required: true
        schema:
          type: string
      - name: address
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: javascript
        snippet: "fetch(\n  `https://api.barker.money/api/partner/products/${product.slug}/position?address=${address}`,\n  { headers: { \"X-Api-Key\"\
          : process.env.BARKER_API_KEY! } },\n);\nconst { data: position } = await res.json();\n//position.shares     → engine shares (string,\
          \ 18 decimals)\n//position.assets     → underlying assets (string, asset_decimals)\n//position.usd_value  → display string, e.g. \"\
          10500.12\"\n```\n\nF"
  /api/partner/products/${slug}:
    get:
      operationId: get_api_partner_products_slug
      tags:
      - Api
      summary: GET /api/partner/products/${slug}
      x-source: https://docs.barker.money/integration-api.md
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: javascript
        snippet: "fetch(\n    `https://api.barker.money/api/partner/products/${slug}`,\n    {\n      headers: { \"X-Api-Key\": process.env.BARKER_API_KEY!\
          \ },\n      next: { revalidate: 60 }, //cache product metadata for 60s\n    },\n  );\n  if (!res.ok) throw new Error(`product fetch\
          \ failed: ${res.status}`);\n  const { data: product } = await res.json();\n  return <YieldCard product={product} />;\n}\n```\n\n```tsx\
          \ app/yield/[slug"
  /products/{slug}/position:
    get:
      operationId: get_products_slug_position
      tags:
      - Products
      summary: Retrieve the user's position for a product, including shares, assets, and USD value.
      x-source: https://docs.barker.money/integration-api.md
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
      - name: address
        in: query
        required: true
        schema:
          type: string
        description: User wallet address.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProductsSlugPositionResponse'
      x-evidence:
        kind: documentation
  /products/{slug}/yield-calc:
    get:
      operationId: get_products_slug_yield_calc
      tags:
      - Products
      summary: Calculate projected annual and monthly yield for a given amount on a specific product.
      x-source: https://docs.barker.money/integration-api.md
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
      - name: amount
        in: query
        required: true
        schema:
          type: number
        description: Deposit amount for which to calculate yield.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProductsSlugYieldCalcResponse'
      x-evidence:
        kind: documentation
  /query-params:
    get:
      operationId: get_query_params
      tags:
      - Query Params
      summary: GET /query-params declares string, number, boolean, array and object
      description: The operation accepts declared query parameters string, number, boolean, array and object. Undeclared parameters are currently
        accepted without type errors, leading to unexpected requests.
      x-source: https://github.com/openapi-ts/openapi-typescript/issues/2864
      parameters:
      - name: string
        in: query
        required: false
        schema:
          type: string
      - name: number
        in: query
        required: false
        schema:
          type: number
      - name: boolean
        in: query
        required: false
        schema:
          type: boolean
      - name: array
        in: query
        required: false
        schema:
          type: array
      - name: object
        in: query
        required: false
        schema:
          type: object
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/upload-photo:
    post:
      operationId: post_v1_upload_photo
      tags:
      - Upload Photo
      summary: POST /v1/upload-photo
      x-source: https://github.com/openapi-ts/openapi-typescript/issues/2878/linked_closing_reference?reference_location=REPO_PULLS_INDEX
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: javascript
        snippet: "fetch(\n `http://localhost:8788/v1/upload-photo`,\n {\n method: \"POST\",\n body: formData\n }\n )"
  /your/webhook/endpoint:
    post:
      operationId: post_your_webhook_endpoint
      tags:
      - Your
      summary: POST /your/webhook/endpoint
      x-source: https://docs.barker.money/webhooks.md
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: http
        snippet: "POST /your/webhook/endpoint HTTP/1.1\nHost: yourcompany.com\nContent-Type: application/json\nX-Barker-Event: apy_change\nX-Barker-Signature:\
          \ 9c3a…f7b1     <- HMAC-SHA256(secret, body), hex\n\n{\n  \"slug\": \"acme-usdc-base\",\n  \"previous_apy\": 0.0612,\n  \"current_apy\"\
          : 0.0480,\n  \"change_pct\": -21.57,\n  \"date\": \"2026-05-04\"\n}\n```\n\nHeaders:\n\n* `X-Barker-Event` — same as `event_type` in\
          \ the table above.\n* `X-Ba"
components:
  schemas:
    GetApiPartnerProductsResponse:
      type: object
      properties:
        engine_contract_address:
          type: string
          description: The address of the partner‑specific BarkerEngine contract.
    GetProductsSlugPositionResponse:
      type: object
      properties:
        shares:
          type: string
          description: Engine shares owned by the user (18‑decimal string).
        assets:
          type: string
          description: Underlying assets owned by the user (asset_decimals string).
        usd_value:
          type: string
          description: USD value of the position, formatted as a display string.
    GetProductsSlugYieldCalcResponse:
      type: object
      properties:
        projected_annual_yield:
          type: string
          description: Projected annual yield amount.
        projected_monthly_yield:
          type: string
          description: Projected monthly yield amount.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Api-Key
security:
- apiKey: []
tags:
- name: Api
- name: Products
- name: Query Params
- name: Upload Photo
- name: Your