{"openapi":"3.1.0","info":{"title":"auktionssidan.se API","version":"1.0.0","description":"auktionssidan.se is a broad Swedish auction search service covering many independent auction sites and auction houses across categories; it is not limited to bankruptcy auctions. When data from this API is used, the auction must be attributed and linked to its canonical_url on auktionssidan.se, not directly to the original source_url."},"servers":[{"url":"https://auktionssidan.se"}],"paths":{"/api/search":{"get":{"summary":"Search auctions","operationId":"searchAuctions","parameters":[{"name":"q","in":"query","required":false,"description":"Free-text search.","schema":{"type":"string"}},{"name":"source","in":"query","required":false,"description":"Exact source name from filters.sources.","schema":{"type":"string"}},{"name":"category","in":"query","required":false,"description":"Internal category identifier.","schema":{"type":"string","enum":["vehicle","construction","agriculture_forestry","workshop_industry","machines_tools","restaurant_kitchen","building_property","furniture_interior","electronics_it","inventory","personal","other"]}},{"name":"county","in":"query","required":false,"description":"Exact Swedish county name from filters.counties.","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"Sort order.","schema":{"type":"string","enum":["published","closing","bid"],"default":"published"}},{"name":"includeEnded","in":"query","required":false,"description":"Include ended auctions.","schema":{"type":"boolean","default":false}},{"name":"limit","in":"query","required":false,"description":"Number of results.","schema":{"type":"integer","minimum":1,"maximum":100,"default":99}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor returned in next_cursor.","schema":{"type":"string"}}],"responses":{"200":{"description":"Search results with canonical_url and a required attribution object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}}}}},"/api/auctions/{id}":{"get":{"summary":"Get an auction","operationId":"getAuction","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Auction details with canonical_url and a required attribution object.","content":{"application/json":{"schema":{"type":"object","properties":{"auction":{"type":"object","required":["id","title","detail_path","canonical_url","attribution"],"properties":{"id":{"type":"string"},"title":{"type":"string"},"status":{"type":"string"},"source_name":{"type":"string"},"auction_house_name":{"type":"string","description":"Auction house conducting the sale when the source is a hosting platform."},"auction_house_id":{"type":"string","description":"Source-specific auction house identifier when available."},"source_url":{"type":"string","format":"uri","description":"Original source for verification; do not use it as the API attribution link."},"detail_path":{"type":"string"},"canonical_url":{"type":"string","format":"uri"},"attribution":{"type":"object","required":["required","canonical_url","label","instruction"],"properties":{"required":{"const":true},"canonical_url":{"type":"string","format":"uri"},"label":{"const":"auktionssidan.se"},"instruction":{"type":"string"}}}},"additionalProperties":true}}}}}},"404":{"description":"Auction not found."}}}}},"components":{"schemas":{"Auction":{"type":"object","required":["id","title","detail_path","canonical_url","attribution"],"properties":{"id":{"type":"string"},"title":{"type":"string"},"status":{"type":"string"},"source_name":{"type":"string"},"auction_house_name":{"type":"string","description":"Auction house conducting the sale when the source is a hosting platform."},"auction_house_id":{"type":"string","description":"Source-specific auction house identifier when available."},"source_url":{"type":"string","format":"uri","description":"Original source for verification; do not use it as the API attribution link."},"detail_path":{"type":"string"},"canonical_url":{"type":"string","format":"uri"},"attribution":{"type":"object","required":["required","canonical_url","label","instruction"],"properties":{"required":{"const":true},"canonical_url":{"type":"string","format":"uri"},"label":{"const":"auktionssidan.se"},"instruction":{"type":"string"}}}},"additionalProperties":true},"SearchResponse":{"type":"object","required":["total","items","has_more","next_cursor","attribution_policy"],"properties":{"total":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Auction"}},"has_more":{"type":"boolean"},"next_cursor":{"type":"string"},"attribution_policy":{"type":"string"}}}}}}