{"openapi":"3.1.0","info":{"title":"Plant Sale Catalogue API","version":"v1","description":"Read-only JSON API over the Plant Sale catalogue: 1,000+ plants for Australian gardens, a controlled facet vocabulary, curated collections and region guides. Public and key-less — see /api/ for the authentication strategy and usage guidance for agents.","license":{"name":"CC BY 4.0","url":"https://creativecommons.org/licenses/by/4.0/"},"contact":{"url":"https://plantsale.com.au/api/"}},"servers":[{"url":"https://plantsale.com.au/api/v1","description":"Production"}],"paths":{"/index.json":{"get":{"operationId":"getApiIndex","summary":"API discovery document (counts, resources, licence)","responses":{"200":{"description":"Discovery document","content":{"application/json":{}}}}}},"/plants.json":{"get":{"operationId":"listPlants","summary":"Full catalogue index — one summary record (all facets) per plant","description":"Returns every indexable plant as a summary record carrying all facet values. Filter client-side, or use /browse/{facet}/{value}.json for a pre-filtered list.","responses":{"200":{"description":"List of plant summaries","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"const":"list"},"count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PlantSummary"}}}}}}}}}},"/plants/{slug}.json":{"get":{"operationId":"getPlant","summary":"Full detail record for one plant","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string"},"description":"Plant slug, e.g. \"howea-forsteriana-kentia-palm\""}],"responses":{"200":{"description":"Plant detail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlantDetail"}}}},"404":{"description":"No plant with that slug"}}}},"/facets.json":{"get":{"operationId":"getFacets","summary":"Controlled vocabulary: facet fields, values, counts and browse URLs","responses":{"200":{"description":"Facet vocabulary","content":{"application/json":{}}}}}},"/browse/{facet}/{value}.json":{"get":{"operationId":"browseByFacet","summary":"Plants holding a given facet value (pre-filtered listing)","parameters":[{"name":"facet","in":"path","required":true,"description":"Facet field. Browse listings exist for these fields.","schema":{"type":"string","enum":["use","light","water","soil","climate_zone","frost","height_band","foliage","flower_season","growth_rate","maintenance","origin","safety","special","form"]}},{"name":"value","in":"path","required":true,"description":"A valid slug for that facet (see /facets.json).","schema":{"type":"string","enum":["angiosperm","conifer","fern","cycad-ginkgo","bryophyte","algae","tree","shrub","climber","groundcover","perennial","annual","grass","bulb","succulent","palm-cycad","fruit-tree","herb-veg","indoor","aquatic","hedging-screening","windbreak","shade","feature","erosion-control","container","hanging-basket","bird-attracting","bee-pollinator","butterfly-attracting","cut-flower","fragrant-use","edible","bonsai","ground-stabilising-lawn","topiary","full-sun","part-shade","full-shade","drought-tolerant","low-water","moderate-water","moist","wet-bog","clay-soil","sandy-soil","loam-soil","well-drained","acidic-soil","alkaline-soil","poor-soil","tropical","subtropical","warm-temperate","cool-temperate","arid-semiarid","mediterranean","frost-hardy","frost-tender","h-under-50cm","h-50cm-1m","h-1-3m","h-3-6m","h-6-10m","h-over-10m","w-under-50cm","w-50cm-1m","w-1-3m","w-3m-plus","evergreen","deciduous","semi-deciduous","variegated","silver-grey-foliage","purple-foliage","gold-foliage","autumn-colour","aromatic-foliage","flower-red","flower-pink","flower-orange","flower-yellow","flower-white","flower-purple","flower-blue","flower-cream-green","flowers-spring","flowers-summer","flowers-autumn","flowers-winter","long-flowering","fast-growing","moderate-growing","slow-growing","low-maintenance","moderate-maintenance","high-maintenance","australian-native","native-nsw","native-vic","native-qld","native-wa","native-sa","native-tas","native-nt","native-act","endemic","exotic","bush-tucker","pet-safe","toxic-pets","toxic-humans","low-allergen","thornless","thorny","coastal","bushfire-bal","water-wise-wels","rabbit-resistant","deer-resistant","award-winning","rare-collector","weed-risk","seed","seedling","tube","pot","advanced","bare-root"]}}],"responses":{"200":{"description":"Matching plant cards","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"const":"browse"},"count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PlantCard"}}}}}}},"404":{"description":"No listing for that facet/value (no members)"}}}},"/collections.json":{"get":{"operationId":"listCollections","summary":"Curated collections (promoted multi-facet intersections)","responses":{"200":{"description":"List of collections","content":{"application/json":{}}}}}},"/collections/{slug}.json":{"get":{"operationId":"getCollection","summary":"One collection with members expanded to cards","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Collection detail","content":{"application/json":{}}},"404":{"description":"No collection with that slug"}}}},"/regions.json":{"get":{"operationId":"listRegions","summary":"Region guides (\"Plants for {city}\")","responses":{"200":{"description":"List of regions","content":{"application/json":{}}}}}},"/regions/{slug}.json":{"get":{"operationId":"getRegion","summary":"One region guide with suited plants expanded to cards","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Region detail","content":{"application/json":{}}},"404":{"description":"No region with that slug"}}}}},"components":{"schemas":{"PlantCard":{"type":"object","properties":{"slug":{"type":"string"},"common_name":{"type":"string"},"scientific_name":{"type":"string"},"family":{"type":"string"},"genus":{"type":"string"},"habit":{"type":"string"},"height_m":{"type":["number","null"]},"width_m":{"type":["number","null"]},"forms":{"type":"array","items":{"type":"string"}},"price_from":{"type":["number","null"],"description":"Lowest listed price in AUD, or null"},"image":{"type":"string","format":"uri"},"page_url":{"type":"string","format":"uri","description":"Human-readable plant page"},"url":{"type":"string","format":"uri","description":"API detail record for this plant"}}},"PlantSummary":{"allOf":[{"$ref":"#/components/schemas/PlantCard"},{"type":"object","description":"A card plus every facet value — the searchable index record.","properties":{"object":{"const":"plant"},"species":{"type":"string"},"cultivar":{"type":["string","null"]},"botanical_group":{"type":"string"},"common_names":{"type":"array","items":{"type":"string"}},"content_tier":{"type":"string","enum":["T1","T2","T3"]},"use":{"type":"array","items":{"type":"string"}},"light":{"type":"array","items":{"type":"string"}},"water":{"type":["string","null"]},"soil":{"type":"array","items":{"type":"string"}},"climate_zone":{"type":"array","items":{"type":"string"}},"frost":{"type":["string","null"]},"height_band":{"type":["string","null"]},"width_band":{"type":["string","null"]},"foliage":{"type":"array","items":{"type":"string"}},"flower_colour":{"type":"array","items":{"type":"string"}},"flower_season":{"type":"array","items":{"type":"string"}},"growth_rate":{"type":["string","null"]},"maintenance":{"type":["string","null"]},"origin":{"type":"array","items":{"type":"string"}},"safety":{"type":"array","items":{"type":"string"}},"special":{"type":"array","items":{"type":"string"}}}}]},"PlantDetail":{"allOf":[{"$ref":"#/components/schemas/PlantSummary"},{"type":"object","description":"Summary plus editorial prose, care, seed data, references and links.","properties":{"summary":{"type":"string"},"care":{"type":["object","null"]},"faqs":{"type":"array","items":{"type":"object"}},"measurements":{"type":"object"},"botanical_synonyms":{"type":"array","items":{"type":"string"}},"entity_refs":{"type":["object","null"]},"forms_detail":{"type":"array","items":{"type":"object"}},"images":{"type":"array","items":{"type":"object"}},"content_html":{"type":["string","null"]},"collections":{"type":"array","items":{"type":"string"}},"related":{"type":"array","items":{"type":"string"}},"meta":{"type":"object"}}}]}}}}