{"openapi":"3.1.0","info":{"title":"OpenRent API (Bowmark)","version":"e833508f87ff","description":"OpenRent (openrent.co.uk) — UK homes and rooms to rent, let directly by private landlords. searchListings() lists what is to let around a UK place or postcode with rent, bedrooms and the tenant flags (pets, students, bills); getListing() reads one listing in full by its link or number.\n\nEvery function Bowmark has for OpenRent (openrent.co.uk) as one HTTP call. Each runs on Bowmark's infrastructure with the same billing, rules and response envelope as `POST /v1/run`. The whole API: https://api.bowmark.ai/openapi.json. Guide: https://bowmark.ai/docs/api.","contact":{"email":"support@bowmark.ai","url":"https://bowmark.ai/docs/api"}},"servers":[{"url":"https://api.bowmark.ai"}],"security":[{"bearer":[]},{"apiKeyHeader":[]}],"paths":{"/v1/sites/openrent/getListing":{"post":{"operationId":"getListing","summary":"Read one OpenRent listing in full by its link or number (`{ listing: 2733150 }` or the openrent.co.uk/property-to-rent/… url).","description":"Read one OpenRent listing in full by its link or number (`{ listing: 2733150 }` or the openrent.co.uk/property-to-rent/… url). Returns status (`available`, `let_agreed`, or `not_found` when OpenRent has no page for that number), title, city, rent pcm and deposit in GBP, bedrooms, bathrooms, available-from, minimum tenancy, furnishing, EPC, every yes/no feature OpenRent ticks (Bills Included, Pets Allowed, Student Friendly, Garden, Parking, Live-In Landlord…), the landlord's description, photos and coordinates. Get a listing number from searchListings.\n\nCalls `bowmark.providers.openrent.getListing`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<OpenRentListing>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"anyOf":[{"$ref":"#/components/schemas/OpenRentGetListingArgs"},{"type":"string"},{"type":"number"}],"description":"TypeScript: `OpenRentGetListingArgs | string | number`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/openrent/searchListings":{"post":{"operationId":"searchListings","summary":"Find homes and rooms to rent on OpenRent around a UK place or postcode (`{ location: \"Bristol\", maxPrice: 1200, minBedrooms: 2, petsAllowed: true }`).","description":"Find homes and rooms to rent on OpenRent around a UK place or postcode (`{ location: \"Bristol\", maxPrice: 1200, minBedrooms: 2, petsAllowed: true }`). Returns every listing OpenRent has for that area (often several hundred, nearest first) after your filters: id, url, rent pcm, bedrooms, bathrooms, studio/shared, furnished, the students / families / pets / DSS / bills flags, garden, parking, days until available, minimum tenancy, date first listed, distance in miles and coordinates; the first ~20 also carry OpenRent's card title and photo. An unrecognised place is an input error. Pass a result's id to getListing for the full listing.\n\nCalls `bowmark.providers.openrent.searchListings`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<OpenRentSearchResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"anyOf":[{"$ref":"#/components/schemas/OpenRentSearchListingsArgs"},{"type":"string"}],"description":"TypeScript: `OpenRentSearchListingsArgs | string`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your Bowmark API key."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Bowmark-Key"}},"responses":{"NotFound":{"description":"No such site or function.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}},"schemas":{"RunEnvelope":{"type":"object","description":"What a run returns. `status` says whether the SCRIPT succeeded. A script that threw or paused for a login is still HTTP 200. Branch on `status`, not on the HTTP code.","required":["ok","status","result","logs","error","ms"],"properties":{"runId":{"type":"string","description":"Stable id for this run. Quote it in a support or `report` message."},"ok":{"type":"boolean","description":"False only when the run produced nothing usable."},"status":{"type":"string","enum":["ok","error","partial","needs_user"],"description":"`partial`: the result is real but some calls failed (see `incomplete`); `ok` stays true. `needs_user`: a person must sign in to a site first. Relay `meta.handoff.url` to them, then run again."},"egress":{"type":"string","enum":["default","link"],"description":"The egress the run was given, present only when the request asked for one. `link`: every request went through the caller's own Chrome (Bowmark Buddy)."},"result":{"description":"Whatever the script `return`ed. Any JSON value."},"logs":{"type":"array","items":{"type":"string"},"description":"Lines the script wrote with `log(...)`."},"error":{"type":["string","null"],"description":"Why the run failed, in plain words. Null on success."},"ms":{"type":"integer","description":"How long the script itself ran, in milliseconds."},"queuedMs":{"type":"integer","description":"How long the run waited for a worker before starting. Present only when it was a second or more."},"needs":{"type":"array","description":"The sign-ins this script is waiting on. Present when `status` is `needs_user`.","items":{"type":"object","required":["capability","provider","providerTitle","kind"],"properties":{"capability":{"type":"string"},"provider":{"type":"string"},"providerTitle":{"type":"string","description":"The site's name, to show a person."},"kind":{"type":"string"}}}},"incomplete":{"type":"object","description":"Present only when `status` is `partial`: which calls did not answer.","properties":{"summary":{"type":"string"},"totalCalls":{"type":"integer"}},"additionalProperties":true},"emptyHanded":{"type":"object","description":"Present when the script returned nothing while its calls returned rows, usually a filter that matched none of the site's own labels. Lists the label values the calls actually returned.","additionalProperties":true},"notes":{"type":"array","description":"Caveats a call attached to a complete answer. Never changes `status`.","items":{"type":"object","properties":{"path":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}},"meta":{"type":"object","properties":{"handoff":{"type":"object","description":"A single-use sign-in link for a person to open. Expires at `expiresAt`.","properties":{"ref":{"type":"string"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"concurrency":{"type":"object","description":"On a 429: how many runs are in flight and when to retry.","properties":{"limit":{"type":"integer"},"inFlight":{"type":"integer"},"retryAfterSeconds":{"type":"integer"}}}},"additionalProperties":true},"notice":{"type":"object","description":"Set when the account owner has not accepted the current Terms. Relay it to them.","additionalProperties":true}}},"OpenRentGetListingArgs":{"type":"object","properties":{"listing":{"anyOf":[{"type":"string"},{"type":"number"}]}},"required":["listing"],"additionalProperties":true},"OpenRentSearchListingsArgs":{"type":"object","properties":{"location":{"type":"string"},"minPrice":{"type":"number"},"maxPrice":{"type":"number"},"minBedrooms":{"type":"number"},"maxBedrooms":{"type":"number"},"petsAllowed":{"type":"boolean"},"studentsAllowed":{"type":"boolean"},"billsIncluded":{"type":"boolean"},"furnished":{"type":"boolean"},"limit":{"type":"number"}},"required":["location"],"additionalProperties":true}}}}