{
  "opencollection": "1.0.0",
  "info": {
    "name": "Copper Platform Trades API",
    "version": "latest"
  },
  "items": [
    {
      "info": {
        "name": "trades",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Trades",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.copper.co/platform/trades",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "query",
                "description": "Organization ID to scope the search"
              },
              {
                "name": "tradeId",
                "value": "",
                "type": "query",
                "description": "Filter by trade ID"
              },
              {
                "name": "tradeReferenceId",
                "value": "",
                "type": "query",
                "description": "Filter by external trade reference ID"
              },
              {
                "name": "effectiveDateFrom",
                "value": "",
                "type": "query",
                "description": "Filter trades with effective date on or after this. Format is unix timestamp (ms)"
              },
              {
                "name": "effectiveDateTo",
                "value": "",
                "type": "query",
                "description": "Filter trades with effective date on or before this. Format is unix timestamp (ms)"
              },
              {
                "name": "maturityDateFrom",
                "value": "",
                "type": "query",
                "description": "Filter trades with maturity date on or after this. Format is unix timestamp (ms)"
              },
              {
                "name": "maturityDateTo",
                "value": "",
                "type": "query",
                "description": "Filter trades with maturity date on or before this. Format is unix timestamp (ms)"
              },
              {
                "name": "tradeSide",
                "value": "",
                "type": "query",
                "description": "Filter by trade side (buy, sell, not-applicable)"
              },
              {
                "name": "tradeStatus",
                "value": "active",
                "type": "query",
                "description": "Filter by trade status"
              },
              {
                "name": "tradeType",
                "value": "forward",
                "type": "query",
                "description": "Filter by trade type (forward, option, swap, other, not-applicable)"
              },
              {
                "name": "counterpartyId",
                "value": "",
                "type": "query",
                "description": "Filter by counterparty ID (creator or acceptor)"
              },
              {
                "name": "includeCollateral",
                "value": "",
                "type": "query",
                "description": "When true, includes collateral details in the response"
              },
              {
                "name": "includeCounterparties",
                "value": "",
                "type": "query",
                "description": "When true, includes counterparty details in the response"
              },
              {
                "name": "includeTradeActions",
                "value": "",
                "type": "query",
                "description": "When true, includes trade actions in the response"
              },
              {
                "name": "includeCollateralTransactions",
                "value": "",
                "type": "query",
                "description": "When true, includes collateral transactions in the response"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results to return."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Number of results to skip for pagination"
              },
              {
                "name": "isOpen",
                "value": "",
                "type": "query",
                "description": "When true, returns only open trades; when false, returns only closed trades"
              }
            ]
          },
          "docs": "Retrieve a list of trades for the given organization."
        },
        {
          "info": {
            "name": "Create Trade",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.copper.co/platform/trades",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Initiate a new trade. The counterparty will need to accept the trade."
        },
        {
          "info": {
            "name": "Accept Trade Close",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.copper.co/platform/trades/:acceptClosureTradeId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "acceptClosureTradeId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Accept a pending trade closure initiated by the counterparty."
        },
        {
          "info": {
            "name": "Accept Trade Default",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.copper.co/platform/trades/:acceptDefaultTradeId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "acceptDefaultTradeId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Accept a pending trade default initiated by the counterparty."
        },
        {
          "info": {
            "name": "Accept Trade",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.copper.co/platform/trades/:acceptTradeId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "acceptTradeId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Accept a trade. This action can only be carried out by the counterparty."
        },
        {
          "info": {
            "name": "Cancel Trade Close",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.copper.co/platform/trades/:cancelClosureTradeId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "cancelClosureTradeId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Cancel a pending trade closure before it has been accepted."
        },
        {
          "info": {
            "name": "Cancel Collateral Top-Up Request",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.copper.co/platform/trades/:cancelCollateralTopUpTradeId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "cancelCollateralTopUpTradeId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Cancel a pending collateral top-up request before it has been reviewed."
        },
        {
          "info": {
            "name": "Cancel Collateral Release Request",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.copper.co/platform/trades/:cancelCollateralTradeId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "cancelCollateralTradeId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Cancel a pending collateral release request before it has been reviewed."
        },
        {
          "info": {
            "name": "Cancel Trade Default",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.copper.co/platform/trades/:cancelDefaultTradeId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "cancelDefaultTradeId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Cancel a pending trade default before it has been accepted."
        },
        {
          "info": {
            "name": "Cancel Trade",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.copper.co/platform/trades/:cancelTradeId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "cancelTradeId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Cancel a trade. Can be initiated by either party before the trade is active."
        },
        {
          "info": {
            "name": "Close Trade",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.copper.co/platform/trades/:closeTradeId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "closeTradeId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Initiate the closure of an active trade and release collateral."
        },
        {
          "info": {
            "name": "Top Up Trade Collateral",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.copper.co/platform/trades/:collateralTopUpTradeId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "collateralTopUpTradeId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add additional collateral to an active trade."
        },
        {
          "info": {
            "name": "Decline Trade",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.copper.co/platform/trades/:declineTradeId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "declineTradeId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Decline a trade. This action can only be carried out by the counterparty."
        },
        {
          "info": {
            "name": "Default Trade",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.copper.co/platform/trades/:defaultTradeId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "defaultTradeId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Mark a trade as defaulted and transfer collateral to the specified portfolio."
        },
        {
          "info": {
            "name": "Request Collateral Release",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.copper.co/platform/trades/:requestCollateralReleaseTradeId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "requestCollateralReleaseTradeId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Request the release of collateral held against the trade."
        },
        {
          "info": {
            "name": "Request Collateral Top-Up",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.copper.co/platform/trades/:requestCollateralTradeId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "requestCollateralTradeId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Request the counterparty to top up their collateral position on the trade."
        },
        {
          "info": {
            "name": "Review Collateral Release Request",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.copper.co/platform/trades/:reviewCollateralReleaseTradeId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "reviewCollateralReleaseTradeId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Approve or reject a pending collateral release request."
        },
        {
          "info": {
            "name": "Review Collateral Top-Up Request",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.copper.co/platform/trades/:reviewCollateraltradeId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "reviewCollateraltradeId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Approve or reject a pending collateral top-up request."
        },
        {
          "info": {
            "name": "Secure Trade Collateral",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.copper.co/platform/trades/:secureTradeId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "secureTradeId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Lock collateral positions against the trade obligations."
        },
        {
          "info": {
            "name": "Get Trade by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.copper.co/platform/trades/:tradeId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "query",
                "description": "Organization ID to scope the request"
              },
              {
                "name": "tradeId",
                "value": "",
                "type": "query",
                "description": "Unique identifier of the trade to retrieve"
              },
              {
                "name": "includeCollateral",
                "value": "",
                "type": "query",
                "description": "When true, includes collateral details in the response"
              },
              {
                "name": "includeCounterparties",
                "value": "",
                "type": "query",
                "description": "When true, includes counterparty details in the response"
              },
              {
                "name": "includeTradeActions",
                "value": "",
                "type": "query",
                "description": "When true, includes trade actions in the response"
              },
              {
                "name": "includeCollateralTransactions",
                "value": "",
                "type": "query",
                "description": "When true, includes collateral transactions in the response"
              },
              {
                "name": "tradeId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve a single trade by its unique identifier."
        }
      ]
    }
  ],
  "bundled": true
}