{"openapi":"3.1.0","info":{"title":"Listingrail API","description":"Sale and rental listings from 18 portals in the US, UK, Europe and the UAE (Zillow, Redfin, Rightmove, Idealista, ImmoScout24, Fotocasa, Daft.ie, Otodom, Hemnet, Bayut, Property Finder and more) in one schema. 1 credit = 1 listing returned.","contact":{"name":"Listingrail","url":"https://listingrail.com/"},"version":"1.0.0","x-logo":{"url":"https://listingrail.com/favicon.svg"}},"servers":[{"url":"https://listingrail.com"}],"paths":{"/v1/sources":{"get":{"tags":["listings"],"summary":"Sources","operationId":"sources_v1_sources_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Sources V1 Sources Get"}}}}},"security":[]}},"/v1/listings/search":{"post":{"tags":["listings"],"summary":"Listings Search","operationId":"listings_search_v1_listings_search_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequest"}}}},"responses":{"200":{"description":"Listings. A `limit` above the balance is cut to the balance and the search still runs; `count` then is below `limit`. `upgrade_url` (the fares table) is added when `credits_remaining` is below 20.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Listings Search V1 Listings Search Post"},"example":{"source":"zumper","location":"Austin, TX","type":"rent","count":12,"credits_used":12,"credits_remaining":0,"upgrade_url":"https://listingrail.com/#fares","listings":[]}}}},"402":{"description":"No credits left. The body names the plans and where to buy them; nothing is charged.","content":{"application/json":{"example":{"detail":{"error":"insufficient_credits","credits_remaining":0,"upgrade_url":"https://listingrail.com/#fares","plans":[{"name":"Pack","credits":2500,"usd":9,"billing":"once"},{"name":"Starter","credits":10000,"usd":29,"billing":"monthly"}],"message":"No credits left. Buy a pack or a plan with the email of this key; credits land on it within a minute."}}}}},"502":{"description":"The portal could not be read. Nothing is charged."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/listings/details":{"post":{"tags":["listings"],"summary":"Listings Details","operationId":"listings_details_v1_listings_details_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Listings Details V1 Listings Details Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/signup":{"post":{"tags":["account"],"summary":"Signup","operationId":"signup_v1_signup_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignupRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Signup V1 Signup Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/v1/account":{"get":{"tags":["account"],"summary":"Account","operationId":"account_v1_account_get","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Account V1 Account Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/usage":{"get":{"tags":["account"],"summary":"Usage","operationId":"usage_v1_usage_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"title":"Limit"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Usage V1 Usage Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors":{"post":{"tags":["monitors"],"summary":"Create Monitor","operationId":"create_monitor_v1_monitors_post","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Create Monitor V1 Monitors Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["monitors"],"summary":"List Monitors","operationId":"list_monitors_v1_monitors_get","parameters":[{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response List Monitors V1 Monitors Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors/{monitor_id}":{"delete":{"tags":["monitors"],"summary":"Delete Monitor","operationId":"delete_monitor_v1_monitors__monitor_id__delete","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"integer","title":"Monitor Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Delete Monitor V1 Monitors  Monitor Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors/{monitor_id}/changes":{"get":{"tags":["monitors"],"summary":"Monitor Changes","operationId":"monitor_changes_v1_monitors__monitor_id__changes_get","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"integer","title":"Monitor Id"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Monitor Changes V1 Monitors  Monitor Id  Changes Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"DetailsRequest":{"properties":{"source":{"type":"string","title":"Source"},"url":{"type":"string","maxLength":2000,"pattern":"^https?://","title":"Url"}},"type":"object","required":["source","url"],"title":"DetailsRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"MonitorRequest":{"properties":{"source":{"type":"string","title":"Source"},"location":{"type":"string","maxLength":500,"minLength":1,"title":"Location"},"filters":{"additionalProperties":true,"type":"object","title":"Filters","description":"type, minPrice, maxPrice, minBeds, limit (1-500, default 50)"},"webhook_url":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Webhook Url"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"}},"type":"object","required":["source","location"],"title":"MonitorRequest"},"SearchRequest":{"properties":{"source":{"type":"string","title":"Source"},"location":{"type":"string","maxLength":500,"minLength":1,"title":"Location"},"type":{"anyOf":[{"type":"string","enum":["rent","sale"]},{"type":"null"}],"title":"Type"},"minPrice":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Minprice"},"maxPrice":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Maxprice"},"minBeds":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Minbeds"},"limit":{"type":"integer","maximum":500.0,"minimum":1.0,"title":"Limit","default":20}},"type":"object","required":["source","location"],"title":"SearchRequest"},"SignupRequest":{"properties":{"email":{"type":"string","format":"email","title":"Email"}},"type":"object","required":["email"],"title":"SignupRequest"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Authorization: Bearer <key>"},"apiKey":{"type":"apiKey","in":"header","name":"X-API-Key"}}},"security":[{"bearer":[]},{"apiKey":[]}]}