Public API Documentation · Halloween.chat Developer API Reference

Public API Documentation for verified license discovery, city lookups, search suggestions, and system health.

/developers/openapi.json · API Changelog · System Status

Interactive API Explorer

GET /api/v1/posts getPosts

Hountix includes eligible published MCP posts. Drafts, invalid metadata and future publication dates are omitted. Homepage promotion dates do not expire the article.

Example Request
curl -s "https://halloween.chat/api/v1/posts"
GET /api/v1/posts/{slug} getPost

One published article for this host

Example Request
curl -s "https://halloween.chat/api/v1/posts/2173"
GET /api/v1/guides listGuides

Published Sociable Pet preparation guides. Optional country filters by exact lowercase country prefix. Sources, check date, cityId, sections and canonical records (id and display label) are the same data used by HTML. Guides do not rank or restrict directory eligibility. Other products return 404.

Example Request
curl -s "https://halloween.chat/api/v1/guides"
GET /api/v1/guides/{slug} getGuide

A published Sociable Pet guide. Country is required to prevent cross-country fallback. Unknown slug, country or product returns 404. This is preparation content, not accreditation or delivery authorization.

Example Request
curl -s "https://halloween.chat/api/v1/guides/2173"
GET /health getHealth

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/health"
GET /api/v1 getApiV1

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/api/v1"
GET /openapi.json getOpenApi

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/openapi.json"
GET /api/v1/openapi.json getApiV1OpenApi

Get live typed OpenAPI 3.1 schema specification

Example Request
curl -s "https://halloween.chat/api/v1/openapi.json"
GET /api/v1/search/semantic searchSemantic

Fast sub-5ms MinHash semantic search over listings

Example Request
curl -s "https://halloween.chat/api/v1/search/semantic"
GET /api/v1/qr generateQrCode

Generate deterministic SVG QR code for verification or print

Example Request
curl -s "https://halloween.chat/api/v1/qr"
GET /api/v1/claims/{id}/window-cling.svg getClaimWindowClingSvg

Generate print-ready vector SVG storefront window cling with QR verification code

Example Request
curl -s "https://halloween.chat/api/v1/claims/2173/window-cling.svg"
GET /api/v1/tours/walking-routes getWalkingRoutes

Generate localized walking route tour itinerary between proximate listings

Example Request
curl -s "https://halloween.chat/api/v1/tours/walking-routes"
GET /api/v1/security/crawler-check checkCrawlerVerification

Verify search engine crawler identity and detect spoofed or AI scrapers

Example Request
curl -s "https://halloween.chat/api/v1/security/crawler-check"
GET /developers getDevelopers

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/developers"
GET /developers/changelog getDevelopersChangelog

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/developers/changelog"
GET /api/v1/pages/city getCityPageDto

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/api/v1/pages/city"
GET /api/v1/listings listListings

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/api/v1/listings"
GET /api/v1/search searchListings

Pet accepts city (country/region/city id), country, region, q (city or postal code), locale, scope (city collection or radius), radius (miles), category (canonical ids or localized slugs, comma-separated), emergency/openNow, sort (distance/name), page, view, limit (1–100) and offset. Explicit city context outranks inferred location; blank unscoped input has no origin. Total counts matched canonical records, not verified businesses or wider source-file records. Unsupported contacts, ratings, tags and ranking boosts are omitted; coordinatePrecision distinguishes approximate positions. HTML uses this same search service with 24 records per page. Tourism accepts scope (global, country, city), city (stable id or existing location), country, locale (en/es), keyword, category, group (eat-drink, art-culture, make, outside, after-dark), neighborhood, radius, sort, page and view. Explicit context returns context, items, total, inventoryTotal, categories (id/count), page, pages and coverage (available, unknown-city, no-coverage, empty-filter). City queries retain radius behavior; global results page within existing shards. Selections never filter directory eligibility. Legacy radius parameters retain their existing response.

Example Request
curl -s "https://halloween.chat/api/v1/search"
GET /api/v1/search/autocomplete autocompleteSearch

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/api/v1/search/autocomplete"
GET /api/v1/search/suggest getSearchSuggestions

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/api/v1/search/suggest"
GET /api/v1/places/{id} getPlaceDto

Hountix published place data, using the same city visibility gate as the website. actualCity is the reviewed venue locality; metro is the directory grouping and city retains that legacy grouping. facts contain key, value, sourceUrl and checkedOn. locations separates source-dated businessAddress, meetingPoint and serviceArea. address remains the Google business address and may be empty for service-area businesses; displayAddress prefers the sourced guest meeting point. timeZone is the recorded venue IANA zone, omitted if unknown. schedule contains sourced date/status, optional kind (attraction_hours by default, ticket_window or departure) and venue-local opens/closes. A departure has opens only. Ticket windows and departures never establish OPEN NOW or attraction closing times. priceOptions contain a named description, decimal-string amount, currency, tax treatment (additional/included/unknown), sourceUrl and checkedOn. Empty arrays mean unconfirmed, never closed or false. Unknown actualCity, contact and licence fields are omitted. Unavailable on other products.

Example Request
curl -s "https://halloween.chat/api/v1/places/2173"
POST /claim/phone/request requestPhoneClaimOtp

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/claim/phone/request"
POST /claim/phone/verify verifyPhoneClaimOtp

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/claim/phone/verify"
POST /claim/domain/challenge getDomainClaimChallenge

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/claim/domain/challenge"
POST /claim/domain/verify verifyDomainClaim

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/claim/domain/verify"
POST /inquire submitLeadInquiry

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/inquire"
POST /api/v1/claims submitClaim

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/api/v1/claims"
GET /api/v1/claims/status getClaimStatus

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/api/v1/claims/status"
GET /api/v1/editions listEditorialEditions

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/api/v1/editions"
GET /api/v1/spots listEditorialSpots

Existing editorial record inventory, independent of featured approval. Each item includes recordId, selections (recordId, cityId, rank, headline, reason, groups, state), and review: kind (venue, neighborhood-guide, workshop, route), status (needs-review, source-reviewed, held), optional canonicalName, identitySource, address/hours/admission/reservation facts (text, sourceUrl, checkedAt), lastChecked, author/reviewer only when documented, conflict, and image (url, alt, credit, license, optional sourceUrl and licenseUrl) or text-only disposition/reason. Legacy unsubstantiated health and registry badges are omitted. The same review supplies HTML facts.

Example Request
curl -s "https://halloween.chat/api/v1/spots"
GET /api/v1/spots/{slug} getEditorialSpot

Shared existing record with the same recordId, review, fact sources and selections documented by listEditorialSpots. Unresolved records remain reachable without featured endorsement.

Example Request
curl -s "https://halloween.chat/api/v1/spots/2173"
GET /api/v1/workshops listEditorialWorkshops

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/api/v1/workshops"
GET /api/v1/activities listEditorialActivities

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/api/v1/activities"
POST /api/v1/spots/{slug}/schedule updateSpotSchedule

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/api/v1/spots/2173/schedule"
POST /api/v1/spots/{slug}/inquire inquireSpot

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/api/v1/spots/2173/inquire"
GET /api/v1/neighborhoods listEditorialNeighborhoods

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/api/v1/neighborhoods"
GET /api/v1/chains listLocalChains

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/api/v1/chains"
GET /api/v1/chains/{slug} getLocalChain

Retains route identity and exports. review.kind is route, status is held until ordered stop identities, compatible schedules and pedestrian travel are checked; conflict explains unresolved evidence. Unverified sequences are inspiration guides.

Example Request
curl -s "https://halloween.chat/api/v1/chains/2173"
GET /api/v1/chains/{slug}/route.geojson getLocalChainGeoJson

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/api/v1/chains/2173/route.geojson"
GET /api/v1/itineraries listEditorialItineraries

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/api/v1/itineraries"
GET /api/v1/itineraries/{slug} getEditorialItinerary

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/api/v1/itineraries/2173"
GET /api/v1/itineraries/{slug}/schedule.ics getEditorialItineraryIcs

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/api/v1/itineraries/2173/schedule.ics"
GET /privacy getPrivacy

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/privacy"
GET /terms getTerms

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/terms"
GET /robots.txt getRobots

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/robots.txt"
GET /health/deep getHealthDeep

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/health/deep"
GET /api/v1/telemetry/metrics getTelemetryMetrics

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/api/v1/telemetry/metrics"
GET /api/v1/telemetry/logpush getTelemetryLogpush

Public edge API endpoint.

Example Request
curl -s "https://halloween.chat/api/v1/telemetry/logpush"

Available Public Endpoints