Skip to content
FIRMSapi Docs

Overview

FIRMSapi preview

Section titled “ FIRMSapi preview ”

Placeholder until the API workstream publishes api/openapi.json (generated from code). Endpoint names follow the plan; parameters and response shapes here are not final.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “ Operations ”
GET
/firms/{code}
GET
/ports
GET
/search
GET
/autocomplete
GET
/nearby
POST
/validate
POST
/batch
GET
/changes
GET
/watchlists

Authentication

Section titled “ Authentication ”

apiKey

Section titled “ apiKey ”

Security scheme type: apiKey

Header parameter name: x-api-key