Publicly Traded Competitors

Publicly Traded Competitors · Actions GPT

Peers Finder API

An API to get peers of a company operating in the same country and sector/industry.

  • GET /stock/peersGet Company Peers

    Get a list of company peers based on the specified symbol and optional grouping criteria.

Schéma original API
{
  "openapi": "3.1.0",
  "info": {
    "title": "Peers Finder API",
    "description": "An API to get peers of a company operating in the same country and sector/industry.",
    "version": "v1.0.0"
  },
  "servers": [
    {
      "url": "https://finnhub.io/api/v1"
    }
  ],
  "paths": {
    "/stock/peers": {
      "get": {
        "summary": "Get Company Peers",
        "operationId": "getCompanyPeers",
        "description": "Get a list of company peers based on the specified symbol and optional grouping criteria.",
        "parameters": [
          {
            "in": "query",
            "name": "symbol",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Symbol of the company."
          },
          {
            "in": "query",
            "name": "grouping",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "sector",
                "industry",
                "subIndustry"
              ]
            },
            "description": "Grouping criteria for peers."
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response with a list of peers.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "FinnhubToken": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {},
    "securitySchemes": {
      "FinnhubToken": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Finnhub-Token"
      }
    }
  },
  "security": [
    {
      "FinnhubToken": []
    }
  ]
}