{
  "openapi": "3.1.0",
  "info": {
    "title": "BestPropFirms data",
    "version": "1.0.0",
    "description": "Read-only prop-firm data published by bestpropfirms.com. Static JSON, no authentication.",
    "contact": {
      "url": "https://www.bestpropfirms.com/about/"
    }
  },
  "servers": [
    {
      "url": "https://www.bestpropfirms.com"
    }
  ],
  "paths": {
    "/api/firms.json": {
      "get": {
        "operationId": "listFirms",
        "summary": "Every prop firm reviewed on this site, with review URL and published score.",
        "responses": {
          "200": {
            "description": "The firm dataset.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FirmDataset"
                }
              }
            }
          }
        }
      }
    },
    "/api/status.json": {
      "get": {
        "operationId": "getStatus",
        "summary": "Build identifier and data freshness for this deployment.",
        "responses": {
          "200": {
            "description": "Status document."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "FirmDataset": {
        "type": "object",
        "required": [
          "count",
          "firms"
        ],
        "properties": {
          "name": {
            "type": "string"
          },
          "generated": {
            "type": "string",
            "format": "date"
          },
          "count": {
            "type": "integer"
          },
          "firms": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Firm"
            }
          }
        }
      },
      "Firm": {
        "type": "object",
        "required": [
          "slug",
          "name"
        ],
        "properties": {
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "status": {
            "type": [
              "string",
              "null"
            ]
          },
          "hqCountry": {
            "type": [
              "string",
              "null"
            ],
            "description": "ISO 3166-1 alpha-2."
          },
          "foundedYear": {
            "type": [
              "integer",
              "null"
            ]
          },
          "marketType": {
            "type": [
              "string",
              "null"
            ]
          },
          "reviewUrl": {
            "type": [
              "string",
              "null"
            ],
            "format": "uri"
          },
          "rating": {
            "type": "integer",
            "description": "Editorial score. Absent when the review carries none."
          },
          "ratingScale": {
            "type": "integer"
          },
          "flagged": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "True when the review carries a warning."
          },
          "lastReviewedAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "lastVerifiedAt": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      }
    }
  }
}