Nexus Mutual Pricing API

openapi: 3.0.2
info:
  title: Cover Router Capacity Pricing API
  version: 2.4.1
servers:
- url: http://127.0.0.1:3000
  description: Local server
- url: https://api.staging.nexusmutual.io/
  description: Staging server
- url: https://api.nexusmutual.io/
  description: Production server
tags:
- name: Pricing
paths:
  /v2/pricing/products/{productId}:
    get:
      tags:
      - Pricing
      description: Get pricing data for a specific product
      parameters:
      - in: path
        name: productId
        required: true
        schema:
          type: integer
          description: The product id
      responses:
        '200':
          description: Returns pricing data of every pool that has capacity for the given product
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PricingResult'
              example:
                productId: 1
                pricePerPool:
                - poolId: 1
                  targetPrice: 250
                - poolId: 2
                  targetPrice: 350
                weightedAveragePrice: 300
        '400':
          description: Invalid productId
        '404':
          description: Product not found
        '500':
          description: Internal Server Error
components:
  schemas:
    PricingResult:
      type: object
      properties:
        productId:
          type: integer
          description: The product id
        pricePerPool:
          type: array
          description: Array of pricing data per pool
          items:
            $ref: '#/components/schemas/PoolPricing'
        weightedAveragePrice:
          type: integer
          description: The weighted average price across all pools as a percentage expressed as basis (0-10,000)
    PoolPricing:
      type: object
      properties:
        poolId:
          type: integer
          description: The pool id
        targetPrice:
          type: integer
          description: The target price as a percentage expressed as basis points (0-10,000)