{
 "openapi": "3.1.0",
 "info": {
  "title": "equitycapital.markets API",
  "version": "1.0.0",
  "description": "Open ledger of U.S. share-offering filings from SEC EDGAR since 4 November 2002: registrations, amendments, effectiveness, final prospectuses, withdrawals, shelves and takedowns. No key. CC BY 4.0. Not affiliated with the SEC.",
  "contact": {
   "email": "office@equitycapital.markets"
  },
  "license": {
   "name": "CC BY 4.0",
   "url": "https://creativecommons.org/licenses/by/4.0/"
  }
 },
 "servers": [
  {
   "url": "https://equitycapital.markets"
  }
 ],
 "paths": {
  "/api/v1/filings": {
   "get": {
    "summary": "List filings, newest first",
    "parameters": [
     {
      "name": "form",
      "in": "query",
      "required": false,
      "description": "One of the 13 forms",
      "schema": {
       "type": "string",
       "enum": [
        "S-1",
        "F-1",
        "S-1/A",
        "F-1/A",
        "DRS",
        "EFFECT",
        "424B4",
        "424B1",
        "RW",
        "S-3",
        "S-3ASR",
        "F-3",
        "424B5"
       ]
      }
     },
     {
      "name": "from",
      "in": "query",
      "required": false,
      "description": "Filed on or after, YYYY-MM-DD",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "to",
      "in": "query",
      "required": false,
      "description": "Filed on or before, YYYY-MM-DD",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "cik",
      "in": "query",
      "required": false,
      "description": "SEC company number",
      "schema": {
       "type": "integer"
      }
     },
     {
      "name": "company",
      "in": "query",
      "required": false,
      "description": "Company name contains",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "1–500, default 100",
      "schema": {
       "type": "integer"
      }
     },
     {
      "name": "page",
      "in": "query",
      "required": false,
      "description": "1-based",
      "schema": {
       "type": "integer"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Filings"
     },
     "400": {
      "description": "Bad request"
     }
    }
   }
  },
  "/api/v1/filings/{accession}": {
   "get": {
    "summary": "One filing and all its filers",
    "parameters": [
     {
      "name": "accession",
      "in": "path",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Filing"
     },
     "400": {
      "description": "Bad request"
     },
     "404": {
      "description": "Not in the ledger"
     }
    }
   }
  },
  "/api/v1/companies": {
   "get": {
    "summary": "Find companies by CIK, ticker or name",
    "parameters": [
     {
      "name": "q",
      "in": "query",
      "required": false,
      "description": "CIK, ticker or part of a name",
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Up to 10 companies"
     },
     "400": {
      "description": "Bad request"
     }
    }
   }
  },
  "/api/v1/companies/{cik}": {
   "get": {
    "summary": "Company card, its offerings and latest 50 filings",
    "parameters": [
     {
      "name": "cik",
      "in": "path",
      "required": true,
      "schema": {
       "type": "integer"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Company"
     },
     "400": {
      "description": "Bad request"
     },
     "404": {
      "description": "Not in the ledger"
     }
    }
   }
  },
  "/api/v1/offerings": {
   "get": {
    "summary": "Offerings (chains under one registration number), latest activity first",
    "parameters": [
     {
      "name": "label",
      "in": "query",
      "required": false,
      "description": "Offering label",
      "schema": {
       "type": "string",
       "enum": [
        "IPO",
        "First-time registration",
        "SPAC",
        "Registered company",
        "Shelf"
       ]
      }
     },
     {
      "name": "status",
      "in": "query",
      "required": false,
      "description": "Offering status",
      "schema": {
       "type": "string",
       "enum": [
        "Filed",
        "Amended",
        "Effective",
        "Final prospectus",
        "Withdrawn",
        "Dormant"
       ]
      }
     },
     {
      "name": "from",
      "in": "query",
      "required": false,
      "description": "Last event on or after",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "to",
      "in": "query",
      "required": false,
      "description": "Last event on or before",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "1–200, default 50",
      "schema": {
       "type": "integer"
      }
     },
     {
      "name": "page",
      "in": "query",
      "required": false,
      "description": "1-based",
      "schema": {
       "type": "integer"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Offerings"
     },
     "400": {
      "description": "Bad request"
     }
    }
   }
  },
  "/api/v1/stats": {
   "get": {
    "summary": "Counts per year or month",
    "description": "ipos_priced: IPOs priced: distinct final prospectuses (424B4/424B1) of offerings labelled IPO; first_time_registrations: Offerings labelled IPO or First-time registration, by date of their first filing; spac_registrations: Offerings labelled SPAC, by date of their first filing; withdrawals: Distinct withdrawal requests (RW); shelf_registrations: Distinct shelf registrations (S-3, S-3ASR, F-3); shelf_takedowns: Distinct shelf takedowns (424B5); include debt and other securities",
    "parameters": [
     {
      "name": "period",
      "in": "query",
      "required": false,
      "description": "year (default) or month",
      "schema": {
       "type": "string",
       "enum": [
        "year",
        "month"
       ]
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Series"
     },
     "400": {
      "description": "Bad request"
     }
    }
   }
  },
  "/api/v1/forms": {
   "get": {
    "summary": "The 13 SEC forms, explained",
    "responses": {
     "200": {
      "description": "Forms"
     },
     "400": {
      "description": "Bad request"
     }
    }
   }
  },
  "/api/v1/status": {
   "get": {
    "summary": "Latest filing day and the last update runs",
    "responses": {
     "200": {
      "description": "Status"
     },
     "400": {
      "description": "Bad request"
     }
    }
   }
  }
 }
}