ImmobilienScout24 · OpenAPI Overlay 1.0.0

API Evangelist overlay for the ImmobilienScout24 API (generated contract)

29 actions 29 updates security extends openapi/_ae-authored/immobilienscout24-openapi-generated.yml
Derived by API Evangelist Built from the contracts ImmobilienScout24 publishes. ImmobilienScout24 did not publish this file.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-agent-hintssecuritySchemessecurity

Targets 29 · first 16 shown; the file carries all of them

$.components
$
$.servers
$.paths['/offer/v1.0/publish'].delete
$.paths['/offer/v1.0/publish'].get
$.paths['/offer/v1.0/publish/list'].delete
$.paths['/offer/v1.0/publish/{id}'].get
$.paths['/offer/v1.0/user/{username or me}/contact/{id or ext-externalId}'].delete
$.paths['/offer/v1.0/user/{username}/contact'].get
$.paths['/offer/v1.0/user/{username}/publishchannel'].get
$.paths['/offer/v1.0/user/{username}/realestate'].get
$.paths['/offer/v1.0/user/{username}/realestate/(ext-){id}/attachment'].get
$.paths['/offer/v1.0/user/{username}/realestate/{id}'].delete
$.paths['/offer/v1.0/user/{username}/realestate/{id}'].get
$.paths['/offer/v1.0/user/{username}/realestate/{id}/attachment/{id}'].delete
$.paths['/offer/v1.0/user/{username}/realestate/{id}/attachment/{id}'].get

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist overlay for the ImmobilienScout24 API (generated contract)
  version: 1.0.0
extends: openapi/_ae-authored/immobilienscout24-openapi-generated.yml
x-generated: '2026-10-28'
x-method: generated
x-source: openapi/_ae-authored/immobilienscout24-openapi-generated.yml
x-rationale: The contract was generated from documentation and has no securitySchemes, no sandbox server and no agent safety
  hints. This overlay adds them without changing the original.
actions:
- target: $.components
  description: Add the OAuth 1.0a three-legged scheme documented at api-docs/authentication/three-legged (the generated contract
    declares none). OpenAPI has no native OAuth 1 type, so it is modelled as the signed Authorization header with the token
    endpoints under x-oauth1.
  update:
    securitySchemes:
      oauth1:
        type: apiKey
        in: header
        name: Authorization
        description: 'OAuth 1.0a signed Authorization header (three-legged). Token endpoints: /restapi/security/oauth/request_token,
          /restapi/security/oauth/confirm_access, /restapi/security/oauth/access_token on rest.immobilienscout24.de.'
        x-oauth1:
          request_token: https://rest.immobilienscout24.de/restapi/security/oauth/request_token
          authorize: https://rest.immobilienscout24.de/restapi/security/oauth/confirm_access
          access_token: https://rest.immobilienscout24.de/restapi/security/oauth/access_token
        x-source: https://api.immobilienscout24.de/api-docs/authentication/three-legged/
- target: $
  description: Apply the OAuth 1.0a requirement at the root.
  update:
    security:
    - oauth1: []
- target: $.servers
  description: Document the production and sandbox REST bases. Docs paths under /offer/v1.0 are served under /restapi/api.
  update:
  - url: https://rest.immobilienscout24.de/restapi/api
    description: Production (paths beginning /offer/...)
  - url: https://rest.sandbox-immobilienscout24.de/restapi/api
    description: 'Sandbox (source: https://api.immobilienscout24.de/api-docs/sandbox/)'
- target: $.paths['/offer/v1.0/publish'].delete
  description: 'Agent hint: destructive operation, confirm with a human first'
  update:
    x-agent-hints:
      destructive: true
      requiresConfirmation: true
- target: $.paths['/offer/v1.0/publish'].get
  description: 'Agent hint: read-only operation'
  update:
    x-agent-hints:
      readOnly: true
      safeToRetry: true
- target: $.paths['/offer/v1.0/publish/list'].delete
  description: 'Agent hint: destructive operation, confirm with a human first'
  update:
    x-agent-hints:
      destructive: true
      requiresConfirmation: true
- target: $.paths['/offer/v1.0/publish/{id}'].get
  description: 'Agent hint: read-only operation'
  update:
    x-agent-hints:
      readOnly: true
      safeToRetry: true
- target: $.paths['/offer/v1.0/user/{username or me}/contact/{id or ext-externalId}'].delete
  description: 'Agent hint: destructive operation, confirm with a human first'
  update:
    x-agent-hints:
      destructive: true
      requiresConfirmation: true
- target: $.paths['/offer/v1.0/user/{username}/contact'].get
  description: 'Agent hint: read-only operation'
  update:
    x-agent-hints:
      readOnly: true
      safeToRetry: true
- target: $.paths['/offer/v1.0/user/{username}/publishchannel'].get
  description: 'Agent hint: read-only operation'
  update:
    x-agent-hints:
      readOnly: true
      safeToRetry: true
- target: $.paths['/offer/v1.0/user/{username}/realestate'].get
  description: 'Agent hint: read-only operation'
  update:
    x-agent-hints:
      readOnly: true
      safeToRetry: true
- target: $.paths['/offer/v1.0/user/{username}/realestate/(ext-){id}/attachment'].get
  description: 'Agent hint: read-only operation'
  update:
    x-agent-hints:
      readOnly: true
      safeToRetry: true
- target: $.paths['/offer/v1.0/user/{username}/realestate/{id}'].delete
  description: 'Agent hint: destructive operation, confirm with a human first'
  update:
    x-agent-hints:
      destructive: true
      requiresConfirmation: true
- target: $.paths['/offer/v1.0/user/{username}/realestate/{id}'].get
  description: 'Agent hint: read-only operation'
  update:
    x-agent-hints:
      readOnly: true
      safeToRetry: true
- target: $.paths['/offer/v1.0/user/{username}/realestate/{id}/attachment/{id}'].delete
  description: 'Agent hint: destructive operation, confirm with a human first'
  update:
    x-agent-hints:
      destructive: true
      requiresConfirmation: true
- target: $.paths['/offer/v1.0/user/{username}/realestate/{id}/attachment/{id}'].get
  description: 'Agent hint: read-only operation'
  update:
    x-agent-hints:
      readOnly: true
      safeToRetry: true
- target: $.paths['/offer/v1.0/user/{username}/realestateproject'].get
  description: 'Agent hint: read-only operation'
  update:
    x-agent-hints:
      readOnly: true
      safeToRetry: true
- target: $.paths['/offer/v1.0/user/{username}/realestateproject/{realestateprojectid}/realestateprojectentry'].get
  description: 'Agent hint: read-only operation'
  update:
    x-agent-hints:
      readOnly: true
      safeToRetry: true
- target: $.paths['/offer/v1.0/user/{username}/realestateproject/{realestateprojectid}'].get
  description: 'Agent hint: read-only operation'
  update:
    x-agent-hints:
      readOnly: true
      safeToRetry: true
- target: $.paths['/offer/v1.0/user/{username}/realestateproject/{realestateprojectid}/attachment'].get
  description: 'Agent hint: read-only operation'
  update:
    x-agent-hints:
      readOnly: true
      safeToRetry: true
- target: $.paths['/offer/v1.0/user/{username}/realestateproject/{realestateprojectid}/attachment/{attachmentid}'].delete
  description: 'Agent hint: destructive operation, confirm with a human first'
  update:
    x-agent-hints:
      destructive: true
      requiresConfirmation: true
- target: $.paths['/offer/v1.0/user/{username}/realestateproject/{realestateprojectid}/attachment/{attachmentid}'].get
  description: 'Agent hint: read-only operation'
  update:
    x-agent-hints:
      readOnly: true
      safeToRetry: true
- target: $.paths['/offer/v1.0/user/{username}/realestateproject/{realestateprojectid}/realestateprojectentry/{realestateid}'].delete
  description: 'Agent hint: destructive operation, confirm with a human first'
  update:
    x-agent-hints:
      destructive: true
      requiresConfirmation: true
- target: $.paths['/restapi/api/offer/v1.0/user/{userId}/videouploadticket'].get
  description: 'Agent hint: read-only operation'
  update:
    x-agent-hints:
      readOnly: true
      safeToRetry: true
- target: $.paths['/restapi/api/offer/v1.0/user/me/realestateproject'].get
  description: 'Agent hint: read-only operation'
  update:
    x-agent-hints:
      readOnly: true
      safeToRetry: true
- target: $.paths['/restapi/api/offer/v1.0/user/me/realestateproject/{realestateprojectId}/realestateprojectentry'].get
  description: 'Agent hint: read-only operation'
  update:
    x-agent-hints:
      readOnly: true
      safeToRetry: true
- target: $.paths['/restapi/api/offer/v1.0/user/{username}/realestate'].get
  description: 'Agent hint: read-only operation'
  update:
    x-agent-hints:
      readOnly: true
      safeToRetry: true
- target: $.paths['/restapi/api/offer/v1.0/user/{username}/realestate/{id}'].get
  description: 'Agent hint: read-only operation'
  update:
    x-agent-hints:
      readOnly: true
      safeToRetry: true
- target: $.paths['/restapi/api/search/v1.0/search/region'].get
  description: 'Agent hint: read-only operation'
  update:
    x-agent-hints:
      readOnly: true
      safeToRetry: true

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay 
curl "https://apis.io/api/v1/overlays/immobilienscout24-openapi-generated-overlay"
All openapi overlays 
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.