> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scrapeunblocker.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Run a Finviz stock screener

> Runs a Finviz screen and returns one page of `rows`, with `totalCount`, `totalPages`, `page`, `pageSize` and `hasNextPage`. Build it from `filters`, `signal` and `order`, or paste a screener link (or its query string) into `query`. `view` picks the columns: 111 overview, 121 valuation, 131 ownership, 141 performance, 161 financial, 171 technical; each row is keyed by column (`ticker`, `company`, `sector`, `marketCap`, `peRatio`, `price`, `changePercent`, `volume`, ...; `columns` lists them). Finviz shows 20 rows per page. Filters that match nothing return an empty `rows`.



## OpenAPI

````yaml /api-reference/openapi.json post /finance/finviz-screener
openapi: 3.1.0
info:
  title: ScrapeUnblocker API
  description: >-
    Public API for the ScrapeUnblocker proxy/anti-bot service. Authenticate
    every request with the `x-scrapeunblocker-key` header. Documented here:
    page-source extraction, Google SERP scraping, image fetch, and the dedicated
    plugin endpoints (search engines, marketplaces, reviews, travel, social and
    more). All other paths exist for internal operations and are intentionally
    hidden from this spec.
  version: 3.0.0
servers:
  - url: https://api.scrapeunblocker.com
    description: Production
security: []
paths:
  /finance/finviz-screener:
    post:
      tags:
        - Plugins
      summary: Run a Finviz stock screener
      description: >-
        Runs a Finviz screen and returns one page of `rows`, with `totalCount`,
        `totalPages`, `page`, `pageSize` and `hasNextPage`. Build it from
        `filters`, `signal` and `order`, or paste a screener link (or its query
        string) into `query`. `view` picks the columns: 111 overview, 121
        valuation, 131 ownership, 141 performance, 161 financial, 171 technical;
        each row is keyed by column (`ticker`, `company`, `sector`, `marketCap`,
        `peRatio`, `price`, `changePercent`, `volume`, ...; `columns` lists
        them). Finviz shows 20 rows per page. Filters that match nothing return
        an empty `rows`.
      operationId: finviz_screener_finance_finviz_screener_post
      parameters:
        - name: query
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              A Finviz screener link or query string, e.g.
              'v=111&f=cap_large,sec_technology&o=-marketcap'.
            title: Query
          description: >-
            A Finviz screener link or query string, e.g.
            'v=111&f=cap_large,sec_technology&o=-marketcap'.
        - name: filters
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Finviz filter codes, comma-separated, e.g.
              'cap_large,sec_technology,fa_pe_u20'.
            title: Filters
          description: >-
            Finviz filter codes, comma-separated, e.g.
            'cap_large,sec_technology,fa_pe_u20'.
        - name: view
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: 'Column set: 111, 121, 131, 141, 161 or 171. Default 111.'
            title: View
          description: 'Column set: 111, 121, 131, 141, 161 or 171. Default 111.'
        - name: order
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Sort, e.g. 'ticker' or '-marketcap' (descending).
            title: Order
          description: Sort, e.g. 'ticker' or '-marketcap' (descending).
        - name: signal
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Finviz signal, e.g. 'ta_topgainers'.
            title: Signal
          description: Finviz signal, e.g. 'ta_topgainers'.
        - name: tickers
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Limit the screen to these tickers, comma-separated.
            title: Tickers
          description: Limit the screen to these tickers, comma-separated.
        - name: etf
          in: query
          required: false
          schema:
            type: boolean
            description: Screen ETFs instead of stocks.
            default: false
            title: Etf
          description: Screen ETFs instead of stocks.
        - name: page
          in: query
          required: false
          schema:
            type: integer
            maximum: 10000
            minimum: 1
            description: Page number, starting at 1.
            default: 1
            title: Page
          description: Page number, starting at 1.
        - name: proxy_country
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Proxy country the request is sent from (ISO-2, e.g. 'US', 'DE').
              Leave blank to let the API pick.
            title: Proxy Country
          description: >-
            Proxy country the request is sent from (ISO-2, e.g. 'US', 'DE').
            Leave blank to let the API pick.
      responses:
        '200':
          description: JSON with `rows` and the page counts.
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid parameter, or `query` is not a Finviz screener address.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '502':
          description: Blocked, unreadable, or the call did not finish in time.
      security:
        - ScrapeUnblockerKey: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ScrapeUnblockerKey:
      type: apiKey
      in: header
      name: x-scrapeunblocker-key
      description: Your ScrapeUnblocker API key. Apply on every request.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.