{ "openapi": "3.0.0", "components": { "examples": {}, "headers": {}, "parameters": {}, "requestBodies": {}, "responses": {}, "schemas": { "ApiSuccessResponse": { "properties": { "statusCode": { "type": "number", "format": "double", "description": "HTTP status code" }, "messageCode": { "type": "string", "description": "Status message code" }, "data": { "description": "Response data" } }, "required": [ "statusCode", "messageCode", "data" ], "type": "object", "additionalProperties": false }, "ApiErrorResponse": { "properties": { "statusCode": { "type": "number", "format": "double", "description": "HTTP status code" }, "messageCode": { "type": "string", "description": "Status message code" }, "message": { "type": "string", "description": "Error message" } }, "required": [ "statusCode", "messageCode", "message" ], "type": "object", "additionalProperties": false }, "PropertyDetailsRequest": { "description": "Request body for fetching property details by URL", "properties": { "url": { "type": "string", "description": "Full URL of the property on Wg-gesucht website", "example": "https://www.wg-gesucht.de/1-zimmer-wohnungen-in-Tuebingen-Tuebingen.12178737.html" } }, "required": [ "url" ], "type": "object", "additionalProperties": false }, "PropertyListRequest": { "description": "Request body for fetching property list by URL", "properties": { "url": { "type": "string", "description": "Full URL of the property list on Wg-gesucht website", "example": "https://www.wg-gesucht.de/1-zimmer-wohnungen-in-Aachen.1.1.1.0.html" } }, "required": [ "url" ], "type": "object", "additionalProperties": false } }, "securitySchemes": {} }, "info": { "title": "WG-Gesucht API", "version": "1.0.0" }, "paths": { "/scrapers/api/wg-gesucht/property/get-by-url": { "post": { "operationId": "Get Property details by url", "responses": { "200": { "description": "Successfully retrieved property details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccessResponse" }, "examples": { "Example 1": { "value": { "statusCode": 200, "messageCode": "OK", "data": [ { "id": "12112971", "url": "https://www.wg-gesucht.de/1-zimmer-wohnungen-in-Aachen-Aachen.12112971.html", "name": "Zimmer im 12. Stock RWTH Schlafsaal", "description": "

\n \n

\n\n

\n Ich suche dringend jemanden, der mein Zimmer unterstellt. Bitte kontaktieren Sie mich, wenn Sie wirklich interessiert sind.
\n Es gibt eine Chance auf dauerhaften Vertrag, wenn während Ihres einen Monats bleiben andere Menschen auf dem Boden zustimmen.
\n Alle Informationen finden Sie hier:
\n
\n http://www2.weh.rwth-aachen.de\n

\n \n

\n I am urgently looking for someone to sublet my room. please contact me if you are really interested.
\n There is a chance of permanent contract if during your one month stay other people on the floor agree to it.
\n Find all the necesary information here:
\n
\n https://www2.weh.rwth-aachen.de\n

\n\n

\n Text automatisch übersetzt -\n Original anzeigen\n Übersetzung anzeigen\n

\n \n \n \n

", "seller": { "image": "https://img.wg-gesucht.de/media/up/2022/15/c6978ffa6d7c3f6e2b431cfa594d309952edd922056b3918a7898469dac4f3bb_ppp.sized.jpg", "name": "https://www.wg-gesucht.de/t_ph.html?qrup=grap36&id=12112971", "created_at": "Mitglied seit April 2021" }, "images": [ "https://img.wg-gesucht.de/./media/up/2025/25/ec1617e82ab0786c355ebed2664b0e16185f7842bb3f78c4ced898f0173b1e02_1213.sized.jpg", null, "https://img.wg-gesucht.de/./media/up/2025/25/ec1617e82ab0786c355ebed2664b0e16185f7842bb3f78c4ced898f0173b1e02_1213.sized.jpg" ], "area": "12m²", "rental_price": "220€", "deposit_price": "220€", "additional_fees": "0€", "other_costs": "n.a.", "agreement": "n.a.", "address": "Rütscherstaße 165 \n 52072 Aachen Aachen", "available": [ { "label": "frei ab", "value": "\n 01.07.2025" }, { "label": "frei bis", "value": "\n 31.07.2025" }, { "label": "Online", "value": " \n 26.06.2025" } ] } ] } } } } } }, "400": { "description": "Bad Request - Invalid URL format", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found - Property not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" }, "examples": { "Example 1": { "value": { "statusCode": 500, "messageCode": "INTERNAL_SERVER_ERROR", "message": "Failed to run robot" } } } } } } }, "description": "Get detailed property information by URL\n\nRetrieves comprehensive property data", "summary": "Get detailed property information", "tags": [ "Property" ], "security": [], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyDetailsRequest" } } } } } }, "/scrapers/api/wg-gesucht/property/listing-by-url": { "post": { "operationId": "Get Property list by url", "responses": { "200": { "description": "Successfully retrieved property information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccessResponse" }, "examples": { "Example 1": { "value": { "statusCode": 200, "messageCode": "OK", "data": [ { "id": "12112971", "url": "https://www.wg-gesucht.de/1-zimmer-wohnungen-in-Aachen-Aachen.12112971.html", "name": "Zimmer im 12. Stock RWTH Schlafsaal", "description": "

\n \n

\n\n

\n \n

\n\n

\n Text automatisch übersetzt -\n Original anzeigen\n Übersetzung anzeigen\n

\n \n \n \n

", "seller": { "image": "https://img.wg-gesucht.de/media/up/2022/15/c6978ffa6d7c3f6e2b431cfa594d309952edd922056b3918a7898469dac4f3bb_ppp.sized.jpg", "name": "https://www.wg-gesucht.de/t_ph.html?qrup=grap36&id=12112971", "created_at": "Mitglied seit April 2021" }, "images": [ "https://img.wg-gesucht.de/./media/up/2025/25/ec1617e82ab0786c355ebed2664b0e16185f7842bb3f78c4ced898f0173b1e02_1213.sized.jpg", null, "https://img.wg-gesucht.de/./media/up/2025/25/ec1617e82ab0786c355ebed2664b0e16185f7842bb3f78c4ced898f0173b1e02_1213.sized.jpg" ], "area": "12m²", "rental_price": "220€", "deposit_price": "220€", "additional_fees": "0€", "other_costs": "n.a.", "agreement": "n.a.", "address": "Rütscherstaße 165 \n 52072 Aachen Aachen", "available": [ { "label": "frei ab", "value": "\n 01.07.2025" }, { "label": "frei bis", "value": "\n 31.07.2025" }, { "label": "Online", "value": " \n 26.06.2025" } ] } ] } } } } } }, "400": { "description": "Bad Request - Invalid URL format", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found - Property not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" }, "examples": { "Example 1": { "value": { "statusCode": 500, "messageCode": "INTERNAL_SERVER_ERROR", "message": "Failed to run robot" } } } } } } }, "description": "Get list of basic property information by URL\n\nRetrieves essential property data without extensive financial history.\nUse this endpoint for faster queries when full details are not needed.", "summary": "Get list basic property information", "tags": [ "Property" ], "security": [], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyListRequest" } } } } } } }, "servers": [ { "url": "/undefined" } ] }