{
  "openapi": "3.1.0",
  "info": {
    "title": "FilingRelay",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://filingrelay.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "bearer": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "security": [
    {
      "bearer": []
    }
  ],
  "paths": {
    "/v1/demo": {
      "get": {
        "summary": "GET /v1/demo",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid credentials"
          },
          "403": {
            "description": "Subscription required"
          },
          "429": {
            "description": "Quota exhausted"
          }
        },
        "security": [],
        "parameters": [
          {
            "name": "kind",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/v1/events": {
      "get": {
        "summary": "GET /v1/events",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid credentials"
          },
          "403": {
            "description": "Subscription required"
          },
          "429": {
            "description": "Quota exhausted"
          }
        },
        "parameters": [
          {
            "name": "important",
            "in": "query",
            "description": "Use 1 for appointments with an Important event assessment. An assessed event includes optional leadership_signal evidence.",
            "schema": { "type": "string", "enum": ["1"] }
          },
          {
            "name": "action",
            "in": "query",
            "description": "Extracted action on an auditor or leadership change.",
            "schema": { "type": "string", "enum": ["appointed", "departed", "resigned", "dismissed"] }
          },
          {
            "name": "person",
            "in": "query",
            "description": "SEC reporting owner CIK, or the CIK of a verified executive mentioned in a leadership filing.",
            "schema": { "type": "string", "example": "0001855684" }
          },
          {
            "name": "cik",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "code",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "exchange",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "form",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "jurisdiction",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "kind",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "office",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "role",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sic",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "ticker",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/v1/changes": {
      "get": {
        "summary": "GET /v1/changes",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid credentials"
          },
          "403": {
            "description": "Subscription required"
          },
          "429": {
            "description": "Quota exhausted"
          }
        },
        "parameters": [
          {
            "name": "after",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 0
            }
          }
        ]
      }
    },
    "/v1/companies": {
      "get": {
        "summary": "GET /v1/companies",
        "responses": {
          "200": {
            "description": "Matching SEC issuers with a market object containing exchange listings, the SEC source and refresh date, and dated index membership observations with source URLs."
          },
          "401": {
            "description": "Invalid credentials"
          },
          "403": {
            "description": "Subscription required"
          },
          "429": {
            "description": "Quota exhausted"
          }
        },
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/v1/filings/{accession}": {
      "get": {
        "summary": "GET /v1/filings/{accession}",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid credentials"
          },
          "403": {
            "description": "Subscription required"
          },
          "429": {
            "description": "Quota exhausted"
          }
        },
        "parameters": [
          {
            "name": "accession",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/v1/watchlists": {
      "get": {
        "summary": "GET /v1/watchlists",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid credentials"
          },
          "403": {
            "description": "Subscription required"
          },
          "429": {
            "description": "Quota exhausted"
          }
        }
      },
      "post": {
        "summary": "POST /v1/watchlists",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid credentials"
          },
          "403": {
            "description": "Subscription required"
          },
          "429": {
            "description": "Quota exhausted"
          }
        }
      }
    },
    "/v1/watchlists/{id}": {
      "patch": {
        "summary": "PATCH /v1/watchlists/{id}",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid credentials"
          },
          "403": {
            "description": "Subscription required"
          },
          "429": {
            "description": "Quota exhausted"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "delete": {
        "summary": "DELETE /v1/watchlists/{id}",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid credentials"
          },
          "403": {
            "description": "Subscription required"
          },
          "429": {
            "description": "Quota exhausted"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/v1/watchlists/{id}/events": {
      "get": {
        "summary": "GET /v1/watchlists/{id}/events",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid credentials"
          },
          "403": {
            "description": "Subscription required"
          },
          "429": {
            "description": "Quota exhausted"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/v1/webhooks": {
      "get": {
        "summary": "GET /v1/webhooks",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid credentials"
          },
          "403": {
            "description": "Subscription required"
          },
          "429": {
            "description": "Quota exhausted"
          }
        }
      },
      "post": {
        "summary": "POST /v1/webhooks",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid credentials"
          },
          "403": {
            "description": "Subscription required"
          },
          "429": {
            "description": "Quota exhausted"
          }
        }
      }
    },
    "/v1/webhooks/{id}": {
      "delete": {
        "summary": "DELETE /v1/webhooks/{id}",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid credentials"
          },
          "403": {
            "description": "Subscription required"
          },
          "429": {
            "description": "Quota exhausted"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/v1/webhooks/{id}/test": {
      "post": {
        "summary": "POST /v1/webhooks/{id}/test",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid credentials"
          },
          "403": {
            "description": "Subscription required"
          },
          "429": {
            "description": "Quota exhausted"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/v1/webhooks/{id}/deliveries": {
      "get": {
        "summary": "GET /v1/webhooks/{id}/deliveries",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid credentials"
          },
          "403": {
            "description": "Subscription required"
          },
          "429": {
            "description": "Quota exhausted"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/v1/webhooks/deliveries/{identifier}/replay": {
      "post": {
        "summary": "POST /v1/webhooks/deliveries/{identifier}/replay",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid credentials"
          },
          "403": {
            "description": "Subscription required"
          },
          "429": {
            "description": "Quota exhausted"
          }
        },
        "parameters": [
          {
            "name": "identifier",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/v1/exports": {
      "get": {
        "summary": "GET /v1/exports",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid credentials"
          },
          "403": {
            "description": "Subscription required"
          },
          "429": {
            "description": "Quota exhausted"
          }
        }
      },
      "post": {
        "summary": "POST /v1/exports",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid credentials"
          },
          "403": {
            "description": "Subscription required"
          },
          "429": {
            "description": "Quota exhausted"
          }
        }
      }
    },
    "/v1/exports/{identifier}": {
      "get": {
        "summary": "GET /v1/exports/{identifier}",
        "responses": {
          "200": {
            "description": "Success"
          },
          "401": {
            "description": "Invalid credentials"
          },
          "403": {
            "description": "Subscription required"
          },
          "429": {
            "description": "Quota exhausted"
          }
        },
        "parameters": [
          {
            "name": "identifier",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    }
  }
}
