> ## 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.

# ImmoScout24 listing API

> Call the ImmoScout24 listing API to get title, status, address, currency, base rent and total rent, as JSON or markdown. 1 credit.

* **Endpoint:** `immoscout.listing`
* **Returns:** `data` has `listing`.
* **Cost:** 1 credit. Failed calls cost nothing.
* **Paging:** No.

## Example

<CodeGroup>
  ```typescript TypeScript icon="https://mintcdn.com/sirathic/7E4w9-IC4ysabjfc/images/icons/typescript.svg?fit=max&auto=format&n=7E4w9-IC4ysabjfc&q=85&s=d8272a85e64145620f1fbbfcf7932986" theme={null}
  import { Stophy } from "stophy";

  const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
  const result = await stophy.immoscout.listing({ listing: "https://www.immobilienscout24.de/expose/123456789" });
  console.log(result.data.listing);
  ```

  ```python Python icon="python" theme={null}
  from stophy import Stophy

  stophy = Stophy()  # reads STOPHY_API_KEY
  result = stophy.immoscout.listing(listing="https://www.immobilienscout24.de/expose/123456789")
  print(result["data"]["listing"])
  ```

  ```bash cURL icon="terminal" theme={null}
  curl -X POST https://api.stophy.dev/v1/immoscout/listing \
    -H "Authorization: Bearer $STOPHY_API_KEY" \
    -H "content-type: application/json" \
    -d '{"listing":"https://www.immobilienscout24.de/expose/123456789"}'
  ```

  ```bash CLI icon="square-terminal" theme={null}
  stophy immoscout listing https://www.immobilienscout24.de/expose/123456789
  ```
</CodeGroup>


## OpenAPI

````yaml api-reference/openapi.json POST /v1/immoscout/listing
openapi: 3.1.0
info:
  title: Stophy API
  version: '1'
  description: >-
    Every endpoint is a POST that takes its input as a JSON object body. Unknown
    fields are rejected with 400.


    Send Accept: text/markdown to get markdown instead of JSON.


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


    x-credits is what one call costs. When x-per-items is set, a call costs
    x-credits for every x-per-items items it returns, and at least x-credits.


    When a response has a cursor, send it back with the same input to get the
    next page.
servers:
  - url: https://api.stophy.dev
security:
  - apiKey: []
paths:
  /v1/immoscout/listing:
    post:
      summary: Get an ImmoScout listing's details
      description: Costs 1 credit.
      operationId: immoscoutListing
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                listing:
                  type: string
              required:
                - listing
              additionalProperties: false
      responses:
        '200':
          description: The data, and the credits this call used.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/RequestId'
            x-credits-used:
              $ref: '#/components/headers/CreditsUsed'
            X-RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                  - creditsUsed
                  - requestId
                properties:
                  success:
                    const: true
                  data:
                    type: object
                    additionalProperties: false
                    properties:
                      listing:
                        type: object
                        additionalProperties: false
                        properties:
                          id:
                            type: string
                          url:
                            type: string
                            format: uri
                          title:
                            type: string
                          type:
                            type: string
                          status:
                            type: string
                          address:
                            type: object
                            additionalProperties: false
                            properties:
                              full:
                                type: string
                              street:
                                type: string
                              city:
                                type: string
                              state:
                                type: string
                              postalCode:
                                type: string
                              country:
                                type: string
                              district:
                                type: string
                            required: []
                          currency:
                            type: string
                            pattern: ^[A-Z]{3}$
                            description: ISO 4217 currency code, e.g. USD.
                          baseRent:
                            type: number
                          totalRent:
                            type: number
                          serviceCharge:
                            type: number
                          price:
                            type: number
                          livingSpace:
                            type: number
                          rooms:
                            type: number
                          yearBuilt:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          energyClass:
                            type: string
                          attributes:
                            type: array
                            items:
                              type: object
                              additionalProperties: false
                              properties:
                                group:
                                  type: string
                                label:
                                  type: string
                                value:
                                  type: string
                              required: []
                          texts:
                            type: array
                            items:
                              type: object
                              additionalProperties: false
                              properties:
                                title:
                                  type: string
                                text:
                                  type: string
                              required: []
                          images:
                            type: array
                            items:
                              type: object
                              additionalProperties: false
                              properties:
                                url:
                                  type: string
                                  format: uri
                                caption:
                                  type: string
                              required:
                                - url
                          agent:
                            type: object
                            additionalProperties: false
                            properties:
                              name:
                                type: string
                              company:
                                type: string
                              phone:
                                type: string
                              rating:
                                type: number
                              url:
                                type: string
                                format: uri
                              address:
                                type: object
                                additionalProperties: false
                                properties:
                                  full:
                                    type: string
                                  street:
                                    type: string
                                  city:
                                    type: string
                                  state:
                                    type: string
                                  postalCode:
                                    type: string
                                  country:
                                    type: string
                                required: []
                            required: []
                        required:
                          - url
                    required:
                      - listing
                  creditsUsed:
                    type: integer
                  requestId:
                    type: string
            text/markdown:
              schema:
                type: string
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
components:
  headers:
    RequestId:
      description: The request id. Quote it when you report a problem.
      schema:
        type: string
    CreditsUsed:
      description: Credits this call used.
      schema:
        type: integer
    RateLimitLimit:
      description: Requests allowed in the current window.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests left in the current window.
      schema:
        type: integer
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
  responses:
    Error:
      description: The request failed. retryable says whether trying again can help.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - success
        - error
      properties:
        success:
          const: false
        error:
          type: object
          required:
            - code
            - message
            - retryable
            - requestId
          properties:
            code:
              type: string
              enum:
                - cliSessionCompleted
                - cliSessionExists
                - cliSessionNotFound
                - forbidden
                - insufficientCredits
                - internalError
                - invalidCliSession
                - invalidCliVerifier
                - invalidRequest
                - notFound
                - rateLimited
                - sourceChanged
                - sourceRefused
                - sourceTimeout
                - sourceUnavailable
                - tooManyInFlight
                - unauthorized
                - unsupportedMediaType
            message:
              type: string
            retryable:
              type: boolean
            retryAfterSeconds:
              type: integer
            requestId:
              type: string
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````