{
  "openapi": "3.0.1",
  "info": {
    "title": "TipRanks Scraper | Analyst Ratings and Price Targets",
    "description": "TipRanks scraper for Wall Street analyst ratings: 60 ratings on 3 tickers in 3 seconds, 46 fields each. Get the analyst and firm, Buy, Hold or Sell, upgrades and downgrades, old and new price targets, success rate and stars, plus each stock's consensus, target range and Smart Score. No login.",
    "version": "1.0",
    "x-build-id": "VzdcgZpcQjmdUO83O"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/silentflow~tipranks-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-silentflow-tipranks-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/silentflow~tipranks-scraper/runs": {
      "post": {
        "operationId": "runs-sync-silentflow-tipranks-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/silentflow~tipranks-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-silentflow-tipranks-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "tickerIds": {
            "title": "📈 Tickers",
            "type": "array",
            "description": "Stocks to read, one per line, as TipRanks writes them: <code>AAPL</code>, <code>NVDA</code>, <code>KO</code>. Stocks listed outside the US take their market prefix: <code>DE:SAP</code>, <code>GB:SHEL</code>, <code>TSE:SHOP</code>, <code>JP:7203</code>. Yahoo Finance style tickers (<code>SAP.DE</code>, <code>SHEL.L</code>) and company names (<code>Coca Cola</code>) are matched too.<br><br>Each ticker returns the latest rating of every analyst covering the stock, newest first, and always at least one row: a stock with no rating left after your filters returns its consensus row.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "🔗 TipRanks pages",
            "type": "array",
            "description": "Paste TipRanks pages copied from your browser:<ul><li>a stock, any tab: <code>https://www.tipranks.com/stocks/aapl/forecast</code>, <code>https://www.tipranks.com/stocks/de:sap/stock-analysis</code></li><li>an analyst profile, for one row per stock the analyst covers, newest rating first: <code>https://www.tipranks.com/experts/analysts/erik-woodring</code></li></ul>",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "daysBack": {
            "title": "📅 Ratings of the last N days",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only the ratings published in the last N days: <code>1</code> for a daily pull of new ratings, <code>7</code> for the past week, <code>90</code> for the window the consensus is built on. <code>0</code> keeps every analyst's latest rating, however old.",
            "default": 0
          },
          "maxItems": {
            "title": "🔢 Max ratings per stock or analyst",
            "minimum": 1,
            "type": "integer",
            "description": "The most ratings returned for each ticker, stock page or analyst, newest first. The cap applies to each entry, never to the list: 10 tickers with <code>5</code> return up to 50 rows, and every ticker returns at least one row.",
            "default": 50
          },
          "actions": {
            "title": "🔄 Rating actions",
            "type": "array",
            "description": "Keep only these rating actions, for example upgrades and downgrades only for an event-driven feed. Leave empty to keep them all.",
            "items": {
              "type": "string",
              "enum": [
                "upgraded",
                "downgraded",
                "initiated",
                "reiterated",
                "assigned"
              ],
              "enumTitles": [
                "Upgraded",
                "Downgraded",
                "Initiated",
                "Reiterated",
                "Assigned"
              ]
            }
          },
          "minAnalystStars": {
            "title": "⭐ Minimum analyst stars",
            "minimum": 0,
            "maximum": 5,
            "type": "number",
            "description": "Keep only analysts TipRanks rates this many stars or more, out of 5, from their success rate and average return: <code>4</code> keeps the top analysts. <code>0</code> keeps every analyst.",
            "default": 0
          },
          "includeAiAnalysts": {
            "title": "🤖 Include TipRanks AI analysts",
            "type": "boolean",
            "description": "Also return the ratings of the AI models TipRanks tracks as analysts (OpenAI, Anthropic, Google and others), marked <code>analystType: ai_model</code>. Off by default, as on the stock page's ratings table.",
            "default": false
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}