Trioptima

opencollection: 1.0.0
info:
  name: Trioptima triReduce API
  version: '1'
request:
  auth:
    type: oauth2
    flow: client_credentials
    accessTokenUrl: https://auth.trireduce.com/oauth/token
    credentials:
      clientId: '{{clientId}}'
      clientSecret: '{{clientSecret}}'
items:
- info:
    name: Cycles
    type: folder
  items:
  - info:
      name: List Compression Cycles
      type: http
    http:
      method: GET
      url: https://rates.trireduce.com/api/v1/cycles
      params:
      - name: status
        value: ''
        type: query
        description: Filter cycles by status
      - name: type
        value: ''
        type: query
        description: Filter by cycle type
    docs: Returns a list of compression cycles available to the participant. Cycles represent scheduled multilateral compression
      runs. Participants can filter by status to see open, in-progress, or completed cycles.
  - info:
      name: Get Cycle Details
      type: http
    http:
      method: GET
      url: https://rates.trireduce.com/api/v1/cycles/:cycleId
      params:
      - name: cycleId
        value: CYC-2024-IRS-001
        type: path
        description: Unique identifier for the compression cycle
    docs: Returns detailed information about a specific compression cycle, including its current status, submission deadlines,
      participating firms, and schedule.
- info:
    name: Trades
    type: folder
  items:
  - info:
      name: List Cycle Trades
      type: http
    http:
      method: GET
      url: https://rates.trireduce.com/api/v1/cycles/:cycleId/trades
      params:
      - name: cycleId
        value: ''
        type: path
        description: Unique identifier for the compression cycle
    docs: Returns the list of trades submitted by the participant for a given compression cycle. Used to verify trade submission
      and review accepted trade population.
  - info:
      name: Submit Trades for Cycle
      type: http
    http:
      method: POST
      url: https://rates.trireduce.com/api/v1/cycles/:cycleId/trades
      params:
      - name: cycleId
        value: ''
        type: path
        description: Unique identifier for the compression cycle
      body:
        type: json
        data: '{}'
    docs: Submits or replaces the participant's trade population for a compression cycle. Trade data includes notional, maturity,
      coupon, and other trade economics required for the compression algorithm. Full access required (not available on read-only
      API keys).
- info:
    name: Risk
    type: folder
  items:
  - info:
      name: Get Cycle Risk Data
      type: http
    http:
      method: GET
      url: https://rates.trireduce.com/api/v1/cycles/:cycleId/risk
      params:
      - name: cycleId
        value: ''
        type: path
        description: Unique identifier for the compression cycle
    docs: Returns the risk data (delta ladders) submitted by the participant for a given compression cycle.
  - info:
      name: Submit Risk Data for Cycle
      type: http
    http:
      method: POST
      url: https://rates.trireduce.com/api/v1/cycles/:cycleId/risk
      params:
      - name: cycleId
        value: ''
        type: path
        description: Unique identifier for the compression cycle
      body:
        type: json
        data: '{}'
    docs: Submits risk constraints (delta ladders, DV01 limits) for a compression cycle. Risk data constrains the optimization
      algorithm to preserve the participant's aggregate risk profile within specified tolerances.
- info:
    name: Results
    type: folder
  items:
  - info:
      name: Get Cycle Results
      type: http
    http:
      method: GET
      url: https://rates.trireduce.com/api/v1/cycles/:cycleId/results
      params:
      - name: cycleId
        value: ''
        type: path
        description: Unique identifier for the compression cycle
    docs: Returns the compression results for a completed cycle, including the set of terminations and new replacement trades,
      notional reduction achieved, and summary statistics.
  - info:
      name: Confirm Cycle Results
      type: http
    http:
      method: POST
      url: https://rates.trireduce.com/api/v1/cycles/:cycleId/results/confirm
      params:
      - name: cycleId
        value: ''
        type: path
        description: Unique identifier for the compression cycle
      body:
        type: json
        data: '{}'
    docs: Confirms the participant's acceptance of the compression results for a cycle. This is required before terminations
      and new trades are processed. All participants must confirm before the cycle settles.
bundled: true