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

# List parsers

> List the parsers: the sites scrape can return as JSON, the page each one reads, what it returns and what it costs.

> [!NOTE]
>
> Needs no API key.

```bash cURL theme={null}
curl https://api.stophy.dev/v1/parsers
```

```json 200 theme={null}
{
  "success": true,
  "data": {
    "parsers": [
      {
        "name": "google-maps",
        "takes": "A Google Maps search page that names a place after in, near or around",
        "example": "https://www.google.com/maps/search/dentists+in+Ljubljana",
        "view": null,
        "response": "…",
        "options": "…",
        "output": "place list",
        "returns": "…",
        "price": "$1 per 1,000 calls",
        "credits": 1,
        "costUsd": 0.001,
        "keyless": true
      }
    ],
    "kinds": {
      "post": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": "…",
        "required": "…",
        "additionalProperties": "…"
      },
      "profile": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": "…",
        "required": "…",
        "additionalProperties": "…"
      },
      "product": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": "…",
        "required": "…",
        "additionalProperties": "…"
      },
      "place": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": "…",
        "required": "…",
        "additionalProperties": "…"
      },
      "review": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": "…",
        "required": "…",
        "additionalProperties": "…"
      },
      "job": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": "…",
        "required": "…",
        "additionalProperties": "…"
      },
      "listing": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": "…",
        "required": "…",
        "additionalProperties": "…"
      },
      "video": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": "…",
        "required": "…",
        "additionalProperties": "…"
      },
      "comment": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": "…",
        "required": "…",
        "additionalProperties": "…"
      },
      "event": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": "…",
        "required": "…",
        "additionalProperties": "…"
      }
    }
  }
}
```


## OpenAPI

````yaml api-reference/openapi.json GET /v1/parsers
openapi: 3.1.0
info:
  title: Stophy API
  version: '1'
  description: >-
    Each operation shows its method and its input: a JSON object body, path and
    query parameters, or a file upload.


    Responses leave out empty values: null, empty strings, empty objects and
    empty nested lists are not sent.


    Text comes back whole. To get shorter responses, add
    ?maxTextLength=<characters> to the URL. Every text value longer than that is
    cut and ends with …. A screenshot is never cut, and a page whose text was
    cut has isTruncated set to true.


    The x-cost-usd response header is what the request cost in dollars. An
    operation's description gives its pricing units and add-ons. The OpenAPI
    fields x-cost-usd and x-cost-usd-max are list-price estimates, not receipts
    or spending limits. When a call starts a job, check the job result for its
    total cost.


    When a response has a cursor, send it back unchanged with the same input to
    get the next page. When it has a page, send the next page number.
servers:
  - url: https://api.stophy.dev
security:
  - apiKey: []
paths:
  /v1/parsers:
    get:
      summary: >-
        List the parsers: the sites scrape can return as JSON, the page each one
        reads, what it returns and what it costs.
      operationId: listParsers
      responses:
        '200':
          description: The parsers.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      parsers:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                            takes:
                              type: string
                            example:
                              type: string
                            options:
                              type: array
                              items:
                                type: object
                            returns:
                              type: array
                              items:
                                type: string
                            price:
                              type: string
                            credits:
                              type: integer
                            keyless:
                              type: boolean
      security: []
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````

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