{"openapi":"3.1.0","info":{"title":"ParseAPI","version":"1.0.0","summary":"Fast APIs for developers, locate, validate, decode.","description":"One base URL, one key, minimal JSON. Response schemas describe API 2.2.0. Paid plans include their profile detail automatically at its natural resource homes; Free returns the complete ordinary answer. There is no deep response object. When neither version header is sent, requests use the saved team default, or 1.0.0 for keyless self-lookups. Read https://parseapi.com/docs/versioning for other supported contracts. Responses that reach the organization rate check carry X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset. Optional X-RateLimit-Burst indicates continuous refill. Rate-limit 429 responses add Retry-After (seconds). See https://parseapi.com/agents and https://parseapi.com/llms.txt for agent-oriented guidance. Field-level docs: https://parseapi.com/docs Free-plan users must include a link to ParseAPI on their website, app, or project documentation. A footer, about page, credits page, or another reasonable location is fine. Paid plans do not require ParseAPI attribution. Example HTML: Data provided by <a href=\"https://parseapi.com\">ParseAPI</a>. Details: https://parseapi.com/legal/attribution#crediting-parseapi.","termsOfService":"https://parseapi.com/legal/terms","contact":{"name":"ParseAPI","email":"hello@parseapi.com","url":"https://parseapi.com"}},"servers":[{"url":"https://api.parseapi.com","description":"Production"}],"tags":[{"name":"Company","description":"Find a company by name, website, ticker or registration identifier.","externalDocs":{"description":"Company API docs","url":"https://parseapi.com/docs/company"}},{"name":"Stack","description":"Identify the technologies observed on a website.","externalDocs":{"description":"Stack API docs","url":"https://parseapi.com/docs/stack"}},{"name":"Card","description":"Card brand and CDN logo from 2–11 leading digits. Optional issuer details in Deep.","externalDocs":{"description":"Card API docs","url":"https://parseapi.com/docs/card"}},{"name":"Industry","description":"Find an industry by code or business activity.","externalDocs":{"description":"Industry API docs","url":"https://parseapi.com/docs/industry"}},{"name":"ASN","description":"A network organization and recorded country from its ASN.","externalDocs":{"description":"ASN Lookup API docs","url":"https://parseapi.com/docs/asn"}},{"name":"IP","description":"Where an IP is from, country, ASN, network.","externalDocs":{"description":"IP Address API docs","url":"https://parseapi.com/docs/ip"}},{"name":"Continent","description":"A continent by code, or every country in it.","externalDocs":{"description":"Continent API docs","url":"https://parseapi.com/docs/continent"}},{"name":"Country","description":"Country names, currency, languages, and timezones.","externalDocs":{"description":"Country API docs","url":"https://parseapi.com/docs/country"}},{"name":"State","description":"A state or province by code or name, with timezones.","externalDocs":{"description":"State API docs","url":"https://parseapi.com/docs/state"}},{"name":"County","description":"A county by code or name, with its state and timezones.","externalDocs":{"description":"County API docs","url":"https://parseapi.com/docs/county"}},{"name":"City","description":"Exact name, typeahead, nearest, or nearby cities. Obra derivada de NGBE Continua CC-BY 4.0 [ign.es](https://www.ign.es/). Selected City reference points adapted by ParseAPI. Feature metadata dates are 2025-10-16 to 2025-10-21; coordinate observation dates are unknown. Source checked 2026-10-16. [IGN reuse terms](https://www.ign.es/resources/licencia/Condiciones_licenciaUso_IGN.pdf). [City source credits](https://parseapi.com/legal/attribution#city-catalog).","externalDocs":{"description":"City API docs","url":"https://parseapi.com/docs/city"}},{"name":"Postal","description":"A ZIP or postal code to its city, state, coordinates, and timezone.","externalDocs":{"description":"Postal API docs","url":"https://parseapi.com/docs/postal"}},{"name":"Address","description":"A US address, checked against official records.","externalDocs":{"description":"Address API docs","url":"https://parseapi.com/docs/address"}},{"name":"Population","description":"Population by place.","externalDocs":{"description":"Population docs","url":"https://parseapi.com/docs/population"}},{"name":"Tax","description":"Sales tax rates and US property-tax medians in paid place detail.","externalDocs":{"description":"Tax docs","url":"https://parseapi.com/docs/tax"}},{"name":"Point","description":"Country, state, county, and timezone at a coordinate.","externalDocs":{"description":"Point API docs","url":"https://parseapi.com/docs/point"}},{"name":"Name","description":"A person's name, split, cased, and checked.","externalDocs":{"description":"Name API docs","url":"https://parseapi.com/docs/name"}},{"name":"Email","description":"Format, domain, role, and a typo suggestion, on every call.","externalDocs":{"description":"Email API docs","url":"https://parseapi.com/docs/email"}},{"name":"Phone","description":"Validate and format a number. 246 countries and regions.","externalDocs":{"description":"Phone Number API docs","url":"https://parseapi.com/docs/phone"}},{"name":"Carrier","description":"Who serves a number: carrier, line type, and burner.","externalDocs":{"description":"Carrier Lookup API docs","url":"https://parseapi.com/docs/carrier"}},{"name":"Caller","description":"The registered caller ID (CNAM) for a number.","externalDocs":{"description":"Caller ID API docs","url":"https://parseapi.com/docs/caller"}},{"name":"HLR","description":"Assignment and reachability at the last network check.","externalDocs":{"description":"HLR Lookup API docs","url":"https://parseapi.com/docs/hlr"}},{"name":"Domain","description":"Whether a domain is available to register.","externalDocs":{"description":"Domain API docs","url":"https://parseapi.com/docs/domain"}},{"name":"DNS","description":"DNS record names, types, values, and remaining TTLs.","externalDocs":{"description":"DNS Lookup API docs","url":"https://parseapi.com/docs/dns"}},{"name":"MX","description":"Mail exchange records for a domain.","externalDocs":{"description":"MX API docs","url":"https://parseapi.com/docs/mx"}},{"name":"Useragent","description":"Device, OS, browser, and bot, from one header.","externalDocs":{"description":"Useragent API docs","url":"https://parseapi.com/docs/useragent"}},{"name":"Language","description":"Detect text in 32 languages, or look up an ISO language code.","externalDocs":{"description":"Language API docs","url":"https://parseapi.com/docs/language"}},{"name":"Time","description":"Local time, timezone lookup, and conversion.","externalDocs":{"description":"Time API docs","url":"https://parseapi.com/docs/time"}},{"name":"Date","description":"An ISO date, validity, and Unix timestamp.","externalDocs":{"description":"Date API docs","url":"https://parseapi.com/docs/date"}},{"name":"Elevation","description":"Elevation at a point, a list of coordinates, or evenly along a path, in feet and meters.","externalDocs":{"description":"Elevation API docs","url":"https://parseapi.com/docs/elevation"}},{"name":"Weather","description":"Current conditions at a latitude and longitude.","externalDocs":{"description":"Weather API docs","url":"https://parseapi.com/docs/weather"}},{"name":"Emoji","description":"Resolve, browse, and find emoji in text.","externalDocs":{"description":"Emoji API docs","url":"https://parseapi.com/docs/emoji"}},{"name":"Holiday","description":"Public holidays by country, year, month, or day.","externalDocs":{"description":"Holiday API docs","url":"https://parseapi.com/docs/holiday"}},{"name":"Currency","description":"Currency names and symbols, plus daily exchange rates.","externalDocs":{"description":"Currency API docs","url":"https://parseapi.com/docs/currency"}},{"name":"Agent tasks","description":"Estimate and authorize bounded lookup work.","externalDocs":{"description":"Agent integration guide","url":"https://parseapi.com/agents"}},{"name":"Account","description":"Check what your account can use, what remains, when allowances reset and what to do next.","externalDocs":{"description":"Account guide","url":"https://parseapi.com/docs/account"}}],"paths":{"/industry/{code}":{"get":{"operationId":"industry","tags":["Industry"],"summary":"Look up a US NAICS industry code","description":"US NAICS 2022 industry name, hierarchy level and immediate parent. Paid deep adds definition, children and classification exclusions. Exclusion descriptions retain general guidance, with linked codes for explicit destinations. Canonical combined sectors are 31-33, 44-45, and 48-49. Their individual two-digit aliases resolve to the combined sector. One pooled request on every plan. Malformed code is 400 and an unknown code is 404. Full field reference: https://parseapi.com/docs/industry","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"code","in":"path","required":true,"description":"A 2-6 digit NAICS code or combined sector","schema":{"type":"string","example":"541511"}},{"name":"deep","in":"query","required":false,"description":"Industry definition, child categories and classification exclusions. Included automatically on paid plans in API 2.2.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","required":["naics","name","level","parent","parent_name","country","year"],"properties":{"naics":{"type":"string"},"name":{"type":"string"},"level":{"type":"integer","minimum":2,"maximum":6},"parent":{"type":["string","null"]},"parent_name":{"type":["string","null"]},"country":{"type":"string","const":"US"},"year":{"type":"integer","const":2022},"description":{"type":["string","null"]},"children":{"type":"array","items":{"type":"object","required":["naics","name"],"properties":{"naics":{"type":"string"},"name":{"type":"string"}}}},"exclusions":{"type":"array","description":"Activities classified elsewhere. An empty array means this code has no published exclusions.","items":{"type":"object","required":["description","codes"],"properties":{"description":{"type":"string"},"codes":{"type":"array","items":{"type":"object","required":["naics","name"],"properties":{"naics":{"type":"string"},"name":{"type":"string"}}},"description":"Explicit destination codes. General guidance may have no specific destination."}}}}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/industry":{"get":{"operationId":"industry_search","tags":["Industry"],"summary":"Search NAICS industries by business activity","description":"Search US NAICS 2022 industry names and activity terms. Results contain classification identity and parent context, plus match, identifying the winning name, term, or code and any spelling corrections. Country and revision are on the search envelope. Bounded typo matching runs only when ordinary search has no results. Ranking indicates text relevance, not classification confidence. No matches returns results: []. One pooled request. Full field reference: https://parseapi.com/docs/industry","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"q","in":"query","required":true,"description":"Business activity or industry keyword","schema":{"type":"string","minLength":1,"maxLength":100,"example":"coffee shop"}},{"name":"limit","in":"query","required":false,"description":"Maximum matching industries","schema":{"type":"integer","minimum":1,"maximum":50,"default":10}},{"name":"deep","in":"query","required":false,"description":"Industry definition, child categories and classification exclusions. Included automatically on paid plans in API 2.2.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","required":["q","country","year","results"],"properties":{"q":{"type":"string"},"country":{"type":"string","const":"US"},"year":{"type":"integer","const":2022},"results":{"type":"array","items":{"type":"object","required":["naics","name","level","parent","parent_name","match"],"properties":{"naics":{"type":"string"},"name":{"type":"string"},"level":{"type":"integer","minimum":2,"maximum":6},"parent":{"type":["string","null"]},"parent_name":{"type":["string","null"]},"match":{"type":"object","required":["field","text","corrections"],"properties":{"field":{"type":"string","enum":["name","term","naics"]},"text":{"type":"string","description":"The actual name, activity term, or code that ranked this result."},"corrections":{"type":"array","description":"Spelling matches as normalized query words and their matched words. Empty for ordinary matches.","items":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string"},"to":{"type":"string"}}}}}},"description":{"type":["string","null"]},"children":{"type":"array","items":{"type":"object","required":["naics","name"],"properties":{"naics":{"type":"string"},"name":{"type":"string"}}}},"exclusions":{"type":"array","description":"Activities classified elsewhere. An empty array means this code has no published exclusions.","items":{"type":"object","required":["description","codes"],"properties":{"description":{"type":"string"},"codes":{"type":"array","items":{"type":"object","required":["naics","name"],"properties":{"naics":{"type":"string"},"name":{"type":"string"}}},"description":"Explicit destination codes. General guidance may have no specific destination."}}}}}}}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/asn/{asn}":{"get":{"operationId":"asn","tags":["ASN"],"summary":"Look up an autonomous system number","description":"Returns asn as an integer, name, country, and country_name. Country is the recorded network country, not its footprint or the location of an IP address. Unknown record fields are null. Malformed input is 400 and an unknown ASN is 404. One pooled request on every plan. deep=true does not add fields or change the lookup. Full field reference: https://parseapi.com/docs/asn","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"asn","in":"path","required":true,"description":"Autonomous system number with an optional AS prefix. Decimal notation only","schema":{"type":"string","example":"AS13335"}},{"name":"deep","in":"query","required":false,"description":"No additional fields or charge","schema":{"type":"boolean"}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"asn":{"type":"integer"},"name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]}},"required":["asn","name","country","country_name"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/ip/{ip}":{"get":{"operationId":"ip","tags":["IP"],"summary":"Look up an IP address","description":"Where an IP is from, country, ASN, network. Full field reference: https://parseapi.com/docs/ip","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"ip","in":"path","required":true,"description":"IPv4 or IPv6 address","schema":{"type":"string","example":"8.8.8.8"}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"deep","in":"query","required":false,"description":"Additional geography, network and security references. Included automatically on paid plans in API 2.2.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"ip":{"type":"string"},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"continent":{"type":["string","null"]},"asn":{"type":["string","null"]},"asn_name":{"type":["string","null"]},"city":{"type":["string","null"]},"county":{"type":["string","null"],"description":"Supported administrative county code, qualified by the response country. U.S. county codes use FIPS."},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"postal":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"timezone":{"type":["string","null"]},"network":{"type":["string","null"]},"asn_type":{"type":["string","null"]},"proxy":{"type":["boolean","null"]},"census_division":{"type":["string","null"],"description":"Supported U.S. Census division, when available."},"census_region":{"type":["string","null"],"description":"Supported U.S. Census region, when available."},"registry":{"type":["string","null"]},"datacenter":{"type":"boolean"},"relay":{"type":"boolean"},"tor":{"type":"boolean"},"vpn":{"type":"boolean"},"provider":{"type":["string","null"]}},"required":["ip","country","country_name","continent","asn","asn_name"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/ip":{"get":{"operationId":"ip_self","tags":["IP"],"summary":"Look up the caller's IP","description":"Returns the IP that made the request. No key needed. Full field reference: https://parseapi.com/docs/ip","security":[{},{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"deep","in":"query","required":false,"description":"Additional geography, network and security references. Included automatically on paid plans in API 2.2.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"ip":{"type":"string"},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"continent":{"type":["string","null"]},"asn":{"type":["string","null"]},"asn_name":{"type":["string","null"]},"city":{"type":["string","null"]},"county":{"type":["string","null"],"description":"Supported administrative county code, qualified by the response country. U.S. county codes use FIPS."},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"postal":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"timezone":{"type":["string","null"]},"network":{"type":["string","null"]},"asn_type":{"type":["string","null"]},"proxy":{"type":["boolean","null"]},"census_division":{"type":["string","null"],"description":"Supported U.S. Census division, when available."},"census_region":{"type":["string","null"],"description":"Supported U.S. Census region, when available."},"registry":{"type":["string","null"]},"datacenter":{"type":"boolean"},"relay":{"type":"boolean"},"tor":{"type":"boolean"},"vpn":{"type":"boolean"},"provider":{"type":["string","null"]}},"required":["ip","country","country_name","continent","asn","asn_name"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/continent":{"get":{"operationId":"continent_list","tags":["Continent"],"summary":"List all continents","description":"A continent by code, or every country in it. Full field reference: https://parseapi.com/docs/continent","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","required":["continents"],"additionalProperties":true,"properties":{"continents":{"type":"array","items":{"type":"object","required":["continent","name"],"additionalProperties":true,"properties":{"continent":{"type":["string","null"]},"name":{"type":["string","null"]}}}}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/continent/{code}":{"get":{"operationId":"continent","tags":["Continent"],"summary":"Look up a continent","description":"A continent by code, or every country in it. Full field reference: https://parseapi.com/docs/continent","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"code","in":"path","required":true,"description":"Two-letter continent code","schema":{"type":"string","enum":["NA","EU","AF","AS","OC","SA","AN"],"example":"NA"}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"continent":{"type":"string"},"name":{"type":["string","null"]},"region":{"type":["string","null"]},"subregion":{"type":["string","null"]},"population":{"type":["integer","null"]},"area":{"type":["integer","null"]},"emoji":{"type":["string","null"]}},"required":["continent","name","region","subregion","population","area","emoji"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/continent/{code}/countries":{"get":{"operationId":"continent_countries","tags":["Continent"],"summary":"List countries in a continent","description":"A continent by code, or every country in it. Full field reference: https://parseapi.com/docs/continent","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"code","in":"path","required":true,"description":"Two-letter continent code","schema":{"type":"string","enum":["NA","EU","AF","AS","OC","SA","AN"],"example":"NA"}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"continent":{"type":"string"},"countries":{"type":"array","items":{"type":"object","properties":{"country":{"type":["string","null"]},"name":{"type":["string","null"]},"flag":{"type":["string","null"]},"calling_code":{"type":["string","null"]}},"required":["country","name"],"additionalProperties":true}}},"required":["continent","countries"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/country":{"get":{"operationId":"country_list","tags":["Country"],"summary":"List countries or country outlines","description":"Ordinary JSON returns the complete dropdown catalog. format=geojson returns a FeatureCollection of country land outlines with those same selected facts. Optionally select up to 50 ISO2 countries with countries=SM,VA; this selector requires format=geojson. The complete outline catalog is substantially larger than the ordinary list. Full field reference: https://parseapi.com/docs/country","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"format","in":"query","required":false,"description":"json by default. geojson returns simplified country land outlines for map display as Polygon/MultiPolygon Features with stable ISO2 IDs. Very small islands and holes may be omitted. Missing outlines retain null geometry; unavailable geometry storage returns 503. Selected country facts and existing Deep access are preserved. API 2.0.0.","schema":{"type":"string","enum":["json","geojson"],"default":"json"}},{"name":"countries","in":"query","required":false,"description":"Optional comma-separated ISO2 codes, at most 50, with format=geojson only. Keeps catalog order and collapses duplicate codes. Unknown codes reject.","schema":{"type":"string","pattern":"^[a-zA-Z]{2}(,[a-zA-Z]{2}){0,49}$","maxLength":149}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","required":["countries"],"additionalProperties":false,"properties":{"countries":{"type":"array","items":{"type":"object","required":["country","name","flag","calling_code"],"additionalProperties":false,"properties":{"country":{"type":"string"},"name":{"type":["string","null"]},"flag":{"type":["string","null"]},"calling_code":{"type":["string","null"]}}}}}}},"application/geo+json":{"schema":{"type":"object","required":["type","features"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"FeatureCollection"},"features":{"type":"array","maxItems":300,"items":{"type":"object","required":["type","id","geometry","properties"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^[A-Z]{2}$"},"geometry":{"description":"Simplified land outline in WGS84 longitude/latitude for map display. Very small islands and holes may be omitted. Null when the stored country outline is unavailable.","anyOf":[{"type":"object","required":["type","coordinates"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"Polygon"},"coordinates":{"type":"array","minItems":1,"items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"maxItems":2,"prefixItems":[{"type":"number","minimum":-180,"maximum":180},{"type":"number","minimum":-90,"maximum":90}],"items":false}}}}},{"type":"object","required":["type","coordinates"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"MultiPolygon"},"coordinates":{"type":"array","minItems":1,"items":{"type":"array","minItems":1,"items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"maxItems":2,"prefixItems":[{"type":"number","minimum":-180,"maximum":180},{"type":"number","minimum":-90,"maximum":90}],"items":false}}}}}},{"type":"null"}]},"properties":{"type":"object","required":["country","name","flag","calling_code"],"additionalProperties":false,"properties":{"country":{"type":"string"},"name":{"type":["string","null"]},"flag":{"type":["string","null"]},"calling_code":{"type":["string","null"]}}}}}}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/country/{code}":{"get":{"operationId":"country","tags":["Country"],"summary":"Look up a country","description":"Core includes country names and codes, demonym (the name for its people), continent, region and subregion, currency, calling code, languages, timezones, borders, country-group memberships and the capital with its coordinates. Paid deep adds statistics, physical geography and regional conventions. GDP is in US dollars; GDP per person and percentage statistics are rounded to two decimal places. elevation_average is average terrain elevation in meters. Missing values stay null. Full field reference: https://parseapi.com/docs/country","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"format","in":"query","required":false,"description":"json by default. geojson returns simplified country land outlines for map display as Polygon/MultiPolygon Features with stable ISO2 IDs. Very small islands and holes may be omitted. Missing outlines retain null geometry; unavailable geometry storage returns 503. Selected country facts and existing Deep access are preserved. API 2.0.0.","schema":{"type":"string","enum":["json","geojson"],"default":"json"}},{"name":"code","in":"path","required":true,"description":"ISO 3166-1 alpha-2 or alpha-3, or a country name (germany)","schema":{"type":"string","example":"US"}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"deep","in":"query","required":false,"description":"Country profiles, physical geography, statistics, regional conventions, tax references and alternate identifiers. Included automatically on paid plans in API 2.2.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"string"},"iso_alpha3":{"type":["string","null"]},"iso_numeric":{"type":["integer","null"]},"name":{"type":["string","null"]},"name_full":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"demonym":{"type":["string","null"]},"continent":{"type":["string","null"]},"region":{"type":["string","null"]},"subregion":{"type":["string","null"]},"currency":{"type":["string","null"]},"currency_name":{"type":["string","null"]},"currency_symbol":{"type":["string","null"]},"calling_code":{"type":["string","null"]},"flag":{"type":["string","null"]},"languages":{"type":["array","null"],"items":{"type":"string"}},"timezones":{"type":["array","null"],"items":{"type":"string"}},"borders":{"type":["array","null"],"items":{"type":"string"}},"blocs":{"type":["array","null"],"items":{"type":"string"}},"capital":{"type":"object","properties":{"name":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]}},"required":["name","latitude","longitude"],"additionalProperties":true},"gdp_usd":{"type":["number","null"],"description":"GDP in current US dollars. Latest available annual figure; null when unavailable.","minimum":0},"gdp_per_capita_usd":{"type":["number","null"],"description":"Rounded to two decimal places. GDP per person in current US dollars. Latest available annual figure; null when unavailable.","minimum":0},"population_growth_percent":{"type":["number","null"],"description":"Rounded to two decimal places. Annual population growth in percent. It may be negative or exceed 100; null when unavailable."},"urban_population_percent":{"type":["number","null"],"description":"Rounded to two decimal places. Urban population as a percentage of total population, from 0 to 100; null when unavailable.","minimum":0,"maximum":100},"internet_users_percent":{"type":["number","null"],"description":"Rounded to two decimal places. People using the internet as a percentage of population, from 0 to 100; null when unavailable.","minimum":0,"maximum":100},"population":{"type":["integer","null"],"description":"Latest available population estimate as a whole-number count; null when unavailable."},"area":{"type":["number","null"]},"land_area":{"type":["number","null"],"minimum":0,"description":"Published land and water areas in km². The split is null when its published total differs from area."},"water_area":{"type":["number","null"],"minimum":0,"description":"Published land and water areas in km². The split is null when its published total differs from area."},"coastline":{"type":["number","null"],"minimum":0,"description":"Published coastline length in kilometers. Zero is a known zero; null is unavailable."},"elevation_average":{"type":["number","null"],"description":"Mean elevation in meters above sea level; null when unavailable."},"lowest_point":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"Published place name; null when unnamed."},"elevation":{"type":"number","description":"Meters above sea level. Negative values are below sea level."}},"required":["name","elevation"],"additionalProperties":true,"description":"Lowest geographic point, or null when unavailable or ambiguous."},"highest_point":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"Published place name; null when unnamed."},"elevation":{"type":"number","description":"Meters above sea level. Negative values are below sea level."}},"required":["name","elevation"],"additionalProperties":true,"description":"Highest geographic point, or null when unavailable or ambiguous."},"tld":{"type":["string","null"]},"tax":{"type":"object","properties":{"name":{"type":["string","null"],"description":"National levy name, such as VAT or GST; null when unavailable or no national levy applies."},"rate":{"type":["number","null"],"description":"Standard national reference rate in percent: 19 means 19%. Not a transaction-specific tax calculation."}},"required":["name","rate"],"additionalProperties":true},"week_start":{"type":["string","null"],"description":"First day of the week. Values include monday, sunday, saturday and friday."},"units":{"type":["string","null"],"description":"Broad local measurement-display preference (metric or imperial), not the units of geography fields. Field-specific metric output defaults stay unchanged."},"driving_side":{"type":["string","null"]},"plugs":{"type":["array","null"],"items":{"type":"string"}},"voltage":{"type":["number","null"],"description":"Common residential mains voltage in volts, not a universal value for every circuit or location; null when unavailable."},"frequency":{"type":["number","null"]},"emergency":{"type":["object","null"],"properties":{"police":{"type":["string","null"]},"ambulance":{"type":["string","null"]},"fire":{"type":["string","null"]}},"required":["police","ambulance","fire"],"additionalProperties":true},"postal_format":{"type":["string","null"],"description":"Simple mask derived from a postal-format example: # is a digit and A is a letter. It may not cover every accepted format; null when no example is available. Does not establish assignment or deliverability."},"postal_regex":{"type":["string","null"],"description":"Anchored postal-code format pattern. A match checks syntax only; it does not establish assignment, existence or address deliverability."},"ioc":{"type":["string","null"]},"fifa":{"type":["string","null"]},"plate":{"type":["string","null"]}},"required":["country","name","name_local","continent","currency","currency_name","currency_symbol","calling_code","flag","languages","timezones","postal_format","postal_regex"],"additionalProperties":true}},"application/geo+json":{"schema":{"type":"object","required":["type","id","geometry","properties"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^[A-Z]{2}$"},"geometry":{"description":"Simplified land outline in WGS84 longitude/latitude for map display. Very small islands and holes may be omitted. Null when the stored country outline is unavailable.","anyOf":[{"type":"object","required":["type","coordinates"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"Polygon"},"coordinates":{"type":"array","minItems":1,"items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"maxItems":2,"prefixItems":[{"type":"number","minimum":-180,"maximum":180},{"type":"number","minimum":-90,"maximum":90}],"items":false}}}}},{"type":"object","required":["type","coordinates"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"MultiPolygon"},"coordinates":{"type":"array","minItems":1,"items":{"type":"array","minItems":1,"items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"maxItems":2,"prefixItems":[{"type":"number","minimum":-180,"maximum":180},{"type":"number","minimum":-90,"maximum":90}],"items":false}}}}}},{"type":"null"}]},"properties":{"type":"object","properties":{"country":{"type":"string"},"iso_alpha3":{"type":["string","null"]},"iso_numeric":{"type":["integer","null"]},"name":{"type":["string","null"]},"name_full":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"demonym":{"type":["string","null"]},"continent":{"type":["string","null"]},"region":{"type":["string","null"]},"subregion":{"type":["string","null"]},"currency":{"type":["string","null"]},"currency_name":{"type":["string","null"]},"currency_symbol":{"type":["string","null"]},"calling_code":{"type":["string","null"]},"flag":{"type":["string","null"]},"languages":{"type":["array","null"],"items":{"type":"string"}},"timezones":{"type":["array","null"],"items":{"type":"string"}},"borders":{"type":["array","null"],"items":{"type":"string"}},"blocs":{"type":["array","null"],"items":{"type":"string"}},"capital":{"type":"object","properties":{"name":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]}},"required":["name","latitude","longitude"],"additionalProperties":true},"gdp_usd":{"type":["number","null"],"description":"GDP in current US dollars. Latest available annual figure; null when unavailable.","minimum":0},"gdp_per_capita_usd":{"type":["number","null"],"description":"Rounded to two decimal places. GDP per person in current US dollars. Latest available annual figure; null when unavailable.","minimum":0},"population_growth_percent":{"type":["number","null"],"description":"Rounded to two decimal places. Annual population growth in percent. It may be negative or exceed 100; null when unavailable."},"urban_population_percent":{"type":["number","null"],"description":"Rounded to two decimal places. Urban population as a percentage of total population, from 0 to 100; null when unavailable.","minimum":0,"maximum":100},"internet_users_percent":{"type":["number","null"],"description":"Rounded to two decimal places. People using the internet as a percentage of population, from 0 to 100; null when unavailable.","minimum":0,"maximum":100},"population":{"type":["integer","null"],"description":"Latest available population estimate as a whole-number count; null when unavailable."},"area":{"type":["number","null"]},"land_area":{"type":["number","null"],"minimum":0,"description":"Published land and water areas in km². The split is null when its published total differs from area."},"water_area":{"type":["number","null"],"minimum":0,"description":"Published land and water areas in km². The split is null when its published total differs from area."},"coastline":{"type":["number","null"],"minimum":0,"description":"Published coastline length in kilometers. Zero is a known zero; null is unavailable."},"elevation_average":{"type":["number","null"],"description":"Mean elevation in meters above sea level; null when unavailable."},"lowest_point":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"Published place name; null when unnamed."},"elevation":{"type":"number","description":"Meters above sea level. Negative values are below sea level."}},"required":["name","elevation"],"additionalProperties":true,"description":"Lowest geographic point, or null when unavailable or ambiguous."},"highest_point":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"Published place name; null when unnamed."},"elevation":{"type":"number","description":"Meters above sea level. Negative values are below sea level."}},"required":["name","elevation"],"additionalProperties":true,"description":"Highest geographic point, or null when unavailable or ambiguous."},"tld":{"type":["string","null"]},"tax":{"type":"object","properties":{"name":{"type":["string","null"],"description":"National levy name, such as VAT or GST; null when unavailable or no national levy applies."},"rate":{"type":["number","null"],"description":"Standard national reference rate in percent: 19 means 19%. Not a transaction-specific tax calculation."}},"required":["name","rate"],"additionalProperties":true},"week_start":{"type":["string","null"],"description":"First day of the week. Values include monday, sunday, saturday and friday."},"units":{"type":["string","null"],"description":"Broad local measurement-display preference (metric or imperial), not the units of geography fields. Field-specific metric output defaults stay unchanged."},"driving_side":{"type":["string","null"]},"plugs":{"type":["array","null"],"items":{"type":"string"}},"voltage":{"type":["number","null"],"description":"Common residential mains voltage in volts, not a universal value for every circuit or location; null when unavailable."},"frequency":{"type":["number","null"]},"emergency":{"type":["object","null"],"properties":{"police":{"type":["string","null"]},"ambulance":{"type":["string","null"]},"fire":{"type":["string","null"]}},"required":["police","ambulance","fire"],"additionalProperties":true},"postal_format":{"type":["string","null"],"description":"Simple mask derived from a postal-format example: # is a digit and A is a letter. It may not cover every accepted format; null when no example is available. Does not establish assignment or deliverability."},"postal_regex":{"type":["string","null"],"description":"Anchored postal-code format pattern. A match checks syntax only; it does not establish assignment, existence or address deliverability."},"ioc":{"type":["string","null"]},"fifa":{"type":["string","null"]},"plate":{"type":["string","null"]}},"required":["country","name","name_local","continent","currency","currency_name","currency_symbol","calling_code","flag","languages","timezones","postal_format","postal_regex"],"additionalProperties":true}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/country/{code}/states":{"get":{"operationId":"country_states","tags":["Country"],"summary":"List states in a country","description":"Country names, currency, languages, and timezones. Full field reference: https://parseapi.com/docs/country","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"format","in":"query","required":false,"description":"json by default. geojson returns simplified administrative Polygon/MultiPolygon outlines with country-qualified IDs and selected facts in properties. Coordinates are longitude first. Missing or ambiguous outlines retain null geometry. Unavailable boundary storage returns 503. Collections retain parent context. Existing Deep access and pooled allowance apply. API 2.0.0 and later.","schema":{"type":"string","enum":["json","geojson"],"default":"json"}},{"name":"code","in":"path","required":true,"description":"ISO country code","schema":{"type":"string","example":"US"}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"string"},"states":{"type":"array","items":{"type":"object","properties":{"state":{"type":["string","null"]},"name":{"type":["string","null"]},"type":{"type":["string","null"]}},"required":["state","name","type"],"additionalProperties":true}}},"required":["country","states"],"additionalProperties":true}},"application/geo+json":{"schema":{"type":"object","properties":{"country":{"type":"string"},"type":{"type":"string","const":"FeatureCollection"},"features":{"type":"array","items":{"type":"object","required":["type","id","geometry","properties"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^[A-Z]{2}-[A-Z0-9-]+$"},"geometry":{"description":"Generalized administrative outline in WGS84 longitude/latitude. Small islands and holes may be omitted. Null when an exact stored outline is missing or ambiguous.","anyOf":[{"type":"object","required":["type","coordinates"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"Polygon"},"coordinates":{"type":"array","minItems":1,"items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"maxItems":2,"prefixItems":[{"type":"number","minimum":-180,"maximum":180},{"type":"number","minimum":-90,"maximum":90}],"items":false}}}}},{"type":"object","required":["type","coordinates"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"MultiPolygon"},"coordinates":{"type":"array","minItems":1,"items":{"type":"array","minItems":1,"items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"maxItems":2,"prefixItems":[{"type":"number","minimum":-180,"maximum":180},{"type":"number","minimum":-90,"maximum":90}],"items":false}}}}}},{"type":"null"}]},"properties":{"type":"object","properties":{"country":{"type":"string"},"name":{"type":["string","null"]},"state":{"type":["string","null"]},"type":{"type":["string","null"]}},"required":["state","name","type"],"additionalProperties":true}}}}},"required":["type","features","country"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/state/{code}":{"get":{"operationId":"state","tags":["State"],"summary":"Look up a state or province","description":"A state or province by code or name, with timezones. Full field reference: https://parseapi.com/docs/state","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"format","in":"query","required":false,"description":"json by default. geojson returns simplified administrative Polygon/MultiPolygon outlines with country-qualified IDs and selected facts in properties. Coordinates are longitude first. Missing or ambiguous outlines retain null geometry. Unavailable boundary storage returns 503. Collections retain parent context. Existing Deep access and pooled allowance apply. API 2.0.0 and later.","schema":{"type":"string","enum":["json","geojson"],"default":"json"}},{"name":"code","in":"path","required":true,"description":"State or province code or name (NC, colorado, ontario)","schema":{"type":"string","example":"colorado"}},{"name":"country","in":"query","required":false,"description":"ISO2, ISO3, or a country name. Optional when the code or name is globally unique. A collision 404s asking for it.","schema":{"type":"string","example":"US"}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"deep","in":"query","required":false,"description":"Population, area and tax references. Every plan includes State identifiers, area codes and capital. Included automatically on paid plans in API 2.2.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"string"},"iso_code":{"type":["string","null"]},"fips":{"type":["string","null"]},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"timezones":{"type":["array","null"],"items":{"type":"string"}},"area_codes":{"type":["array","null"],"items":{"type":"string"}},"capital":{"type":"object","properties":{"name":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]}},"required":["name","latitude","longitude"],"additionalProperties":true},"population":{"type":["integer","null"]},"area":{"type":["number","null"]},"tax":{"type":"object","properties":{"name":{"type":["string","null"]},"rate":{"type":["number","null"]}},"required":["name","rate"],"additionalProperties":true}},"required":["state","name","name_local","type","country","country_name","latitude","longitude","timezones","iso_code","fips","area_codes","capital"],"additionalProperties":true}},"application/geo+json":{"schema":{"type":"object","required":["type","id","geometry","properties"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^[A-Z]{2}-[A-Z0-9-]+$"},"geometry":{"description":"Generalized administrative outline in WGS84 longitude/latitude. Small islands and holes may be omitted. Null when an exact stored outline is missing or ambiguous.","anyOf":[{"type":"object","required":["type","coordinates"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"Polygon"},"coordinates":{"type":"array","minItems":1,"items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"maxItems":2,"prefixItems":[{"type":"number","minimum":-180,"maximum":180},{"type":"number","minimum":-90,"maximum":90}],"items":false}}}}},{"type":"object","required":["type","coordinates"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"MultiPolygon"},"coordinates":{"type":"array","minItems":1,"items":{"type":"array","minItems":1,"items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"maxItems":2,"prefixItems":[{"type":"number","minimum":-180,"maximum":180},{"type":"number","minimum":-90,"maximum":90}],"items":false}}}}}},{"type":"null"}]},"properties":{"type":"object","properties":{"state":{"type":"string"},"iso_code":{"type":["string","null"]},"fips":{"type":["string","null"]},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"timezones":{"type":["array","null"],"items":{"type":"string"}},"area_codes":{"type":["array","null"],"items":{"type":"string"}},"capital":{"type":"object","properties":{"name":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]}},"required":["name","latitude","longitude"],"additionalProperties":true},"population":{"type":["integer","null"]},"area":{"type":["number","null"]},"tax":{"type":"object","properties":{"name":{"type":["string","null"]},"rate":{"type":["number","null"]}},"required":["name","rate"],"additionalProperties":true}},"required":["state","name","name_local","type","country","country_name","latitude","longitude","timezones","iso_code","fips","area_codes","capital"],"additionalProperties":true}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/state/{code}/counties":{"get":{"operationId":"state_counties","tags":["State"],"summary":"List counties and comparable administrative areas in a state","description":"A state or province by code or name, with timezones. Full field reference: https://parseapi.com/docs/state","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"format","in":"query","required":false,"description":"json by default. geojson returns simplified administrative Polygon/MultiPolygon outlines with country-qualified IDs and selected facts in properties. Coordinates are longitude first. Missing or ambiguous outlines retain null geometry. Unavailable boundary storage returns 503. Collections retain parent context. Existing Deep access and pooled allowance apply. API 2.0.0 and later.","schema":{"type":"string","enum":["json","geojson"],"default":"json"}},{"name":"code","in":"path","required":true,"description":"State / province code or name","schema":{"type":"string","example":"NC"}},{"name":"country","in":"query","required":false,"description":"ISO2, ISO3, or a country name. Optional when the code is globally unique.","schema":{"type":"string","example":"US"}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"deep","in":"query","required":false,"description":"Population, area and tax references. Every plan includes State identifiers, area codes and capital. Included automatically on paid plans in API 2.2.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"string"},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"counties":{"type":"array","items":{"type":"object","properties":{"county":{"type":["string","null"]},"iso_code":{"type":["string","null"]},"name":{"type":["string","null"]},"type":{"type":["string","null"]},"population":{"type":["integer","null"]}},"required":["county","iso_code","name","type"],"additionalProperties":true}}},"required":["state","state_name","country","country_name","counties"],"additionalProperties":true}},"application/geo+json":{"schema":{"type":"object","properties":{"state":{"type":"string"},"type":{"type":"string","const":"FeatureCollection"},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"state_name":{"type":["string","null"]},"features":{"type":"array","items":{"type":"object","required":["type","id","geometry","properties"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^[A-Z]{2}-[A-Z0-9-]+$"},"geometry":{"description":"Generalized administrative outline in WGS84 longitude/latitude. Small islands and holes may be omitted. Null when an exact stored outline is missing or ambiguous.","anyOf":[{"type":"object","required":["type","coordinates"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"Polygon"},"coordinates":{"type":"array","minItems":1,"items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"maxItems":2,"prefixItems":[{"type":"number","minimum":-180,"maximum":180},{"type":"number","minimum":-90,"maximum":90}],"items":false}}}}},{"type":"object","required":["type","coordinates"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"MultiPolygon"},"coordinates":{"type":"array","minItems":1,"items":{"type":"array","minItems":1,"items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"maxItems":2,"prefixItems":[{"type":"number","minimum":-180,"maximum":180},{"type":"number","minimum":-90,"maximum":90}],"items":false}}}}}},{"type":"null"}]},"properties":{"type":"object","properties":{"state":{"type":"string"},"iso_code":{"type":["string","null"]},"name":{"type":["string","null"]},"type":{"type":["string","null"]},"country":{"type":"string"},"county":{"type":["string","null"]},"population":{"type":["integer","null"]}},"required":["county","iso_code","name","type"],"additionalProperties":true}}}}},"required":["type","features","state","state_name","country","country_name"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/county/{code}":{"get":{"operationId":"county","tags":["County"],"summary":"Look up a county or comparable administrative area by code or name","description":"A county by code or name, with its state and timezones. Full field reference: https://parseapi.com/docs/county","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"format","in":"query","required":false,"description":"json by default. geojson returns simplified administrative Polygon/MultiPolygon outlines with country-qualified IDs and selected facts in properties. Coordinates are longitude first. Missing or ambiguous outlines retain null geometry. Unavailable boundary storage returns 503. Collections retain parent context. Existing Deep access and pooled allowance apply. API 2.0.0 and later.","schema":{"type":"string","enum":["json","geojson"],"default":"json"}},{"name":"code","in":"path","required":true,"description":"County code or name (08031, guilford county, E09000033)","schema":{"type":"string","example":"08031"}},{"name":"country","in":"query","required":false,"description":"ISO2, ISO3, or a country name. Optional when the code or name is unique.","schema":{"type":"string","example":"US"}},{"name":"state","in":"query","required":false,"description":"ADM1 code or name. Narrows name lookups. Prefer louisiana over LA, which collides across countries, or include country=US.","schema":{"type":"string","example":"NC"}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"deep","in":"query","required":false,"description":"Population, area, the seat of government and US county property-tax medians. Included automatically on paid plans in API 2.2.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"county":{"type":["string","null"]},"iso_code":{"type":["string","null"]},"name":{"type":["string","null"]},"type":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"timezones":{"type":["array","null"],"items":{"type":"string"}},"population":{"type":["integer","null"]},"area":{"type":["number","null"]},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"seat":{"type":["string","null"]},"property_tax":{"type":["object","null"],"properties":{"annual_median":{"type":"integer","minimum":0,"description":"Median annual amount in currency, adjusted to the final year of period."},"currency":{"type":"string","const":"USD"},"period":{"type":"string","pattern":"^\\d{4}(-\\d{4})?$","description":"Observation period for the estimate."}},"required":["annual_median","currency","period"],"additionalProperties":true,"description":"Median annual real-estate tax payable on owner-occupied housing, in US dollars adjusted to the final year of period. Available US ZIP-area and county estimates only. Not a percentage or an individual property bill. Null when missing, censored or unsupported."}},"required":["county","iso_code","name","type","state","state_name","country","country_name","latitude","longitude","timezones"],"additionalProperties":true}},"application/geo+json":{"schema":{"type":"object","required":["type","id","geometry","properties"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^[A-Z]{2}-[A-Z0-9-]+$"},"geometry":{"description":"Generalized administrative outline in WGS84 longitude/latitude. Small islands and holes may be omitted. Null when an exact stored outline is missing or ambiguous.","anyOf":[{"type":"object","required":["type","coordinates"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"Polygon"},"coordinates":{"type":"array","minItems":1,"items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"maxItems":2,"prefixItems":[{"type":"number","minimum":-180,"maximum":180},{"type":"number","minimum":-90,"maximum":90}],"items":false}}}}},{"type":"object","required":["type","coordinates"],"additionalProperties":false,"properties":{"type":{"type":"string","const":"MultiPolygon"},"coordinates":{"type":"array","minItems":1,"items":{"type":"array","minItems":1,"items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"maxItems":2,"prefixItems":[{"type":"number","minimum":-180,"maximum":180},{"type":"number","minimum":-90,"maximum":90}],"items":false}}}}}},{"type":"null"}]},"properties":{"type":"object","properties":{"county":{"type":["string","null"]},"iso_code":{"type":["string","null"]},"name":{"type":["string","null"]},"type":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"timezones":{"type":["array","null"],"items":{"type":"string"}},"population":{"type":["integer","null"]},"area":{"type":["number","null"]},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"seat":{"type":["string","null"]},"property_tax":{"type":["object","null"],"properties":{"annual_median":{"type":"integer","minimum":0,"description":"Median annual amount in currency, adjusted to the final year of period."},"currency":{"type":"string","const":"USD"},"period":{"type":"string","pattern":"^\\d{4}(-\\d{4})?$","description":"Observation period for the estimate."}},"required":["annual_median","currency","period"],"additionalProperties":true,"description":"Median annual real-estate tax payable on owner-occupied housing, in US dollars adjusted to the final year of period. Available US ZIP-area and county estimates only. Not a percentage or an individual property bill. Null when missing, censored or unsupported."}},"required":["county","iso_code","name","type","state","state_name","country","country_name","latitude","longitude","timezones"],"additionalProperties":true}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/city/{name}":{"get":{"operationId":"city","tags":["City"],"summary":"Look up a city by name","description":"Every city response carries a stable id (city_...). Store it and fetch the same city with /city/id/{id}. Full field reference: https://parseapi.com/docs/city","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"type","in":"query","required":false,"description":"Filter the recorded place type, such as city or ward.","schema":{"type":"string","minLength":1,"maxLength":60}},{"name":"grain","in":"query","required":false,"description":"Filter a reviewed geographic layer. Unreviewed records do not match.","schema":{"type":"string","enum":["municipality","subdivision","locality","metropolitan_area"]}},{"name":"hierarchy","in":"query","required":false,"description":"Include the reviewed grain and immediate parent on each City. Unknown relationships are null.","schema":{"type":"boolean","const":true}},{"name":"aliases","in":"query","required":false,"description":"Also match reviewed official name forms. Applies to name lookup and search, without spelling correction.","schema":{"type":"boolean","const":true}},{"name":"ambiguity","in":"query","required":false,"description":"Require a unique eligible exact name match; otherwise return HTTP 409 ambiguous_city with up to two safe City candidates.","schema":{"type":"string","enum":["error"]}},{"name":"format","in":"query","required":false,"description":"Use geojson for stored-center Features. Omit to retain this route’s default response.","schema":{"type":"string","enum":["geojson"]}},{"name":"name","in":"path","required":true,"description":"City name","schema":{"type":"string","example":"charlotte"}},{"name":"country","in":"query","required":false,"description":"ISO country code to disambiguate","schema":{"type":"string","example":"US"}},{"name":"state","in":"query","required":false,"description":"State code such as FL or US-FL. Get codes from /country/{country}/states. State names return 400. A country prefix must match the country filter.","schema":{"type":"string","minLength":1,"maxLength":6,"pattern":"^(?:[A-Za-z]{2}-)?[A-Za-z0-9]{1,3}$","example":"FL"}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"deep","in":"query","required":false,"description":"Population, its known observation date and basis, area, elevation and capital status. Included automatically on paid plans in API 2.2.","schema":{"type":"boolean"}},{"name":"If-None-Match","in":"header","required":false,"description":"Validate a cached canonical response or relationship list. Matching validators return 304 without a body; ordinary request billing and rate limits still apply.","schema":{"type":"string"}},{"name":"romanized","in":"query","required":false,"description":"Include reviewed official romanized name_romanized and romanization_language. Missing or conflicting forms remain null; no ASCII-folding substitute. Available reviewed forms currently cover 20 Japanese whole-city aliases.","schema":{"type":"boolean","const":true}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"ETag":{"description":"Validator for the selected City representation and serving edition. Conditional HTTP reads can return 304. Ordinary pooled request billing and rate limits still apply.","schema":{"type":"string"}},"Cache-Control":{"description":"private, no-cache: retain a cached body but validate before reuse.","schema":{"type":"string","const":"private, no-cache"}},"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","latitude","longitude","timezone","id"],"properties":{"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"timezone":{"type":["string","null"]},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"id":{"type":["string","null"],"description":"Stable city identifier when available."}}},{"type":"object","required":["type","id","geometry","properties"],"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^city_[a-z0-9]{12}$"},"geometry":{"oneOf":[{"type":"null"},{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","const":"Point"},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number"},"description":"Longitude, latitude of the stored center."}}}]},"properties":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","timezone"],"properties":{"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"match":{"type":"object","required":["type","value","language"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"language":{"type":["string","null"]}}}},"additionalProperties":true}}},{"type":"object","required":["type","features","next_cursor"],"properties":{"type":{"type":"string","const":"FeatureCollection"},"features":{"type":"array","items":{"type":"object","required":["type","id","geometry","properties"],"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^city_[a-z0-9]{12}$"},"geometry":{"oneOf":[{"type":"null"},{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","const":"Point"},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number"},"description":"Longitude, latitude of the stored center."}}}]},"properties":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","timezone"],"properties":{"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"match":{"type":"object","required":["type","value","language"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"language":{"type":["string","null"]}}}},"additionalProperties":true}}}},"next_cursor":{"type":["string","null"],"description":"Opaque cursor for another page, or null at the end. Search and named nearby include this only with page=true or cursor."}},"additionalProperties":true}],"description":"Default response or GeoJSON. Complete City facts and stable identity."}},"application/geo+json":{"schema":{"type":"object","required":["type","id","geometry","properties"],"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^city_[a-z0-9]{12}$"},"geometry":{"oneOf":[{"type":"null"},{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","const":"Point"},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number"},"description":"Longitude, latitude of the stored center."}}}]},"properties":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","timezone"],"properties":{"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"match":{"type":"object","required":["type","value","language"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"language":{"type":["string","null"]}}}},"additionalProperties":true}}}}}},"304":{"description":"The selected canonical or catalog metadata representation is unchanged. No response body; ordinary request billing and rate limits apply.","headers":{"ETag":{"description":"Validator for the selected City representation and serving edition. Conditional HTTP reads can return 304. Ordinary pooled request billing and rate limits still apply.","schema":{"type":"string"}},"Cache-Control":{"description":"private, no-cache: retain a cached body but validate before reuse.","schema":{"type":"string","const":"private, no-cache"}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"ambiguous_city with bounded safe identity choices when ambiguity=error.","content":{"application/json":{"schema":{"type":"object","required":["code","message","candidates"],"properties":{"code":{"type":"string","const":"ambiguous_city"},"message":{"type":"string"},"candidates":{"type":"array","maxItems":2,"items":{"type":"object","required":["id","object"],"properties":{"id":{"type":"string"},"object":{"type":"string","const":"city"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"type":{"type":["string","null"]}},"additionalProperties":false}}},"additionalProperties":true}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/city":{"get":{"operationId":"city_query","tags":["City"],"summary":"Browse, search or find cities around coordinates","description":"Pass browse=true to list covered cities, q for prefix search, or lat and lon for the nearest recorded place center within 2,000 km. Add nearby=true to coordinates for a radius collection. Country, state, type and grain narrow eligible records. Population, elevation, country sets, timezone sets, bbox, sorting and cursors apply only to collections. Search returns cities; nearby queries return nearby. Relations return data arrays. Population filters and sorting use the same count as paid Deep at the returned place layer. Browse defaults to name; search to relevance; nearby to distance. Nearest-center distance does not prove municipal containment. Choose exactly one input mode. Use API version 2.2.0. Full field reference: https://parseapi.com/docs/city","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"type","in":"query","required":false,"description":"Filter the recorded place type, such as city or ward.","schema":{"type":"string","minLength":1,"maxLength":60}},{"name":"grain","in":"query","required":false,"description":"Filter a reviewed geographic layer. Unreviewed records do not match.","schema":{"type":"string","enum":["municipality","subdivision","locality","metropolitan_area"]}},{"name":"hierarchy","in":"query","required":false,"description":"Include the reviewed grain and immediate parent on each City. Unknown relationships are null.","schema":{"type":"boolean","const":true}},{"name":"aliases","in":"query","required":false,"description":"Also match reviewed official name forms. Applies to name lookup and search, without spelling correction.","schema":{"type":"boolean","const":true}},{"name":"format","in":"query","required":false,"description":"Use geojson for stored-center Features. Omit to retain this route’s default response.","schema":{"type":"string","enum":["geojson"]}},{"name":"countries","in":"query","required":false,"description":"Comma-separated ISO2 country set; at most 50 distinct codes. Collection results must belong to this set.","schema":{"type":"string","minLength":2,"maxLength":149,"example":"JP,AT"}},{"name":"exclude_countries","in":"query","required":false,"description":"Comma-separated ISO2 countries excluded from collection results.","schema":{"type":"string","minLength":2,"maxLength":149}},{"name":"timezones","in":"query","required":false,"description":"Comma-separated exact IANA timezone set.","schema":{"type":"string","minLength":1,"maxLength":5049}},{"name":"min_elevation","in":"query","required":false,"description":"Inclusive minimum known elevation, in meters. Unknown values do not match.","schema":{"type":"number"}},{"name":"max_elevation","in":"query","required":false,"description":"Inclusive maximum known elevation, in meters; must be at least the minimum.","schema":{"type":"number"}},{"name":"min_population","in":"query","required":false,"description":"Inclusive minimum known population at the returned place layer. Unknown counts do not match.","schema":{"type":"integer","minimum":0,"maximum":9007199254740991}},{"name":"max_population","in":"query","required":false,"description":"Inclusive maximum known population. Must be at least min_population when both are supplied.","schema":{"type":"integer","minimum":0,"maximum":9007199254740991}},{"name":"bbox","in":"query","required":false,"description":"Place-center bounds west,south,east,north in degrees. West greater than east crosses the dateline. This does not test municipal boundary intersection.","schema":{"type":"string","example":"130,30,145,45"}},{"name":"page","in":"query","required":false,"description":"Include next_cursor on prefix search or named nearby. Browse and coordinate nearby always include it.","schema":{"type":"boolean","const":true}},{"name":"cursor","in":"query","required":false,"description":"Opaque next_cursor from the previous response. Keep the original query options, including limit, unchanged. Invalid or changed cursors return 400; restart without a cursor. Verified revision-reader pages bind to their immutable edition; restart after an edition change. Legacy-reader pages follow the current catalog.","schema":{"type":"string","minLength":1,"maxLength":700}},{"name":"browse","in":"query","required":false,"description":"List covered cities without a name prefix, optionally narrowed by country or other collection filters.","schema":{"type":"boolean","const":true}},{"name":"nearby","in":"query","required":false,"description":"Return a radius collection around lat and lon. Omit for the original single nearest-city response.","schema":{"type":"boolean","const":true}},{"name":"sort","in":"query","required":false,"description":"Up to three keys: name, population, country, elevation; relevance for search and distance for nearby. Prefix a key with - for descending or + for ascending. Unknown values sort last.","schema":{"type":"string","maxLength":100,"example":"-population,name"}},{"name":"radius","in":"query","required":false,"description":"Coordinate nearby radius, default 40 km or 25 mi, max 800 km or 500 mi.","schema":{"type":"number","exclusiveMinimum":0,"maximum":800}},{"name":"unit","in":"query","required":false,"description":"Coordinate nearby radius unit.","schema":{"type":"string","enum":["km","mi"],"default":"km"}},{"name":"q","in":"query","required":false,"description":"City name prefix, at least two characters. Required for search; use lat and lon instead for the nearest city.","schema":{"type":"string","minLength":2,"example":"char"}},{"name":"lat","in":"query","required":false,"description":"Latitude. Pass with lon for the nearest city, or use q for name search.","schema":{"type":"number","minimum":-90,"maximum":90,"example":35.2271}},{"name":"lon","in":"query","required":false,"description":"Longitude. Required with lat; use q instead for name search.","schema":{"type":"number","minimum":-180,"maximum":180,"example":-80.8431}},{"name":"country","in":"query","required":false,"description":"Two-letter country code to narrow name search or coordinate matches.","schema":{"type":"string","pattern":"^[a-zA-Z]{2}$","example":"US"}},{"name":"state","in":"query","required":false,"description":"State code such as FL or US-FL. Get codes from /country/{country}/states. State names return 400. A country prefix must match the country filter.","schema":{"type":"string","minLength":1,"maxLength":6,"pattern":"^(?:[A-Za-z]{2}-)?[A-Za-z0-9]{1,3}$","example":"FL"}},{"name":"limit","in":"query","required":false,"description":"Maximum results per collection page. Nearest-city lookup returns one city.","schema":{"type":"integer","minimum":1,"maximum":50,"default":10}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"deep","in":"query","required":false,"description":"Population, its known observation date and basis, area, elevation and capital status. Included automatically on paid plans in API 2.2.","schema":{"type":"boolean"}},{"name":"If-None-Match","in":"header","required":false,"description":"Validate a cached canonical response or relationship list. Matching validators return 304 without a body; ordinary request billing and rate limits still apply.","schema":{"type":"string"}},{"name":"romanized","in":"query","required":false,"description":"Include reviewed official romanized name_romanized and romanization_language. Missing or conflicting forms remain null; no ASCII-folding substitute. Available reviewed forms currently cover 20 Japanese whole-city aliases.","schema":{"type":"boolean","const":true}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"ETag":{"description":"Validator for the selected City representation and serving edition. Conditional HTTP reads can return 304. Ordinary pooled request billing and rate limits still apply.","schema":{"type":"string"}},"Cache-Control":{"description":"private, no-cache: retain a cached body but validate before reuse.","schema":{"type":"string","const":"private, no-cache"}},"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"anyOf":[{"oneOf":[{"type":"object","required":["q","cities"],"properties":{"q":{"type":"string"},"country":{"type":"string","description":"Present when a country filter was supplied."},"state":{"type":"string","description":"Present when a state filter was supplied."},"type":{"type":"string"},"grain":{"type":"string","enum":["municipality","subdivision","locality","metropolitan_area"]},"aliases":{"type":"boolean"},"cities":{"type":"array","items":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","latitude","longitude","timezone","id"],"properties":{"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"timezone":{"type":["string","null"]},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"id":{"type":["string","null"],"description":"Stable city identifier when available."}}}},"next_cursor":{"type":["string","null"],"description":"Opaque cursor for another page, or null at the end. Search and named nearby include this only with page=true or cursor."}}},{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","latitude","longitude","timezone","id","distance","distance_mi"],"properties":{"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"id":{"type":["string","null"],"description":"Stable city identifier when available."}}},{"type":"object","required":["cities","next_cursor"],"not":{"required":["q"]},"properties":{"country":{"type":"string"},"state":{"type":"string"},"type":{"type":"string"},"grain":{"type":"string","enum":["municipality","subdivision","locality","metropolitan_area"]},"cities":{"type":"array","items":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","latitude","longitude","timezone","id"],"properties":{"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"timezone":{"type":["string","null"]},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"id":{"type":["string","null"],"description":"Stable city identifier when available."}}}},"next_cursor":{"type":["string","null"],"description":"Opaque cursor for another page, or null at the end. Search and named nearby include this only with page=true or cursor."}}},{"type":"object","required":["latitude","longitude","radius","unit","nearby","next_cursor"],"properties":{"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"radius":{"type":"number"},"unit":{"type":"string","enum":["km","mi"]},"nearby":{"type":"array","items":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","latitude","longitude","timezone","id","distance","distance_mi"],"properties":{"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"id":{"type":["string","null"],"description":"Stable city identifier when available."}}}},"next_cursor":{"type":["string","null"],"description":"Opaque cursor for another page, or null at the end. Search and named nearby include this only with page=true or cursor."}}}]},{"type":"object","required":["type","id","geometry","properties"],"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^city_[a-z0-9]{12}$"},"geometry":{"oneOf":[{"type":"null"},{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","const":"Point"},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number"},"description":"Longitude, latitude of the stored center."}}}]},"properties":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","timezone"],"properties":{"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"match":{"type":"object","required":["type","value","language"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"language":{"type":["string","null"]}}}},"additionalProperties":true}}},{"type":"object","required":["type","features","next_cursor"],"properties":{"type":{"type":"string","const":"FeatureCollection"},"features":{"type":"array","items":{"type":"object","required":["type","id","geometry","properties"],"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^city_[a-z0-9]{12}$"},"geometry":{"oneOf":[{"type":"null"},{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","const":"Point"},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number"},"description":"Longitude, latitude of the stored center."}}}]},"properties":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","timezone"],"properties":{"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"match":{"type":"object","required":["type","value","language"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"language":{"type":["string","null"]}}}},"additionalProperties":true}}}},"next_cursor":{"type":["string","null"],"description":"Opaque cursor for another page, or null at the end. Search and named nearby include this only with page=true or cursor."}},"additionalProperties":true}],"description":"Default response or GeoJSON. Complete City facts and stable identity."}},"application/geo+json":{"schema":{"anyOf":[{"type":"object","required":["type","id","geometry","properties"],"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^city_[a-z0-9]{12}$"},"geometry":{"oneOf":[{"type":"null"},{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","const":"Point"},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number"},"description":"Longitude, latitude of the stored center."}}}]},"properties":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","timezone"],"properties":{"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"country":{"type":"string"},"state":{"type":["string","null"]},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"match":{"type":"object","required":["type","value","language"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"language":{"type":["string","null"]}}}},"additionalProperties":true}}},{"type":"object","required":["type","features","next_cursor"],"properties":{"type":{"type":"string","const":"FeatureCollection"},"features":{"type":"array","items":{"type":"object","required":["type","id","geometry","properties"],"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^city_[a-z0-9]{12}$"},"geometry":{"oneOf":[{"type":"null"},{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","const":"Point"},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number"},"description":"Longitude, latitude of the stored center."}}}]},"properties":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","timezone"],"properties":{"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"country":{"type":"string"},"state":{"type":["string","null"]},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"match":{"type":"object","required":["type","value","language"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"language":{"type":["string","null"]}}}},"additionalProperties":true}}}},"next_cursor":{"type":["string","null"],"description":"Opaque cursor for another page, or null at the end. Search and named nearby include this only with page=true or cursor."}},"additionalProperties":true}]}}}},"304":{"description":"The selected canonical or catalog metadata representation is unchanged. No response body; ordinary request billing and rate limits apply.","headers":{"ETag":{"description":"Validator for the selected City representation and serving edition. Conditional HTTP reads can return 304. Ordinary pooled request billing and rate limits still apply.","schema":{"type":"string"}},"Cache-Control":{"description":"private, no-cache: retain a cached body but validate before reuse.","schema":{"type":"string","const":"private, no-cache"}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/city/id/{id}":{"get":{"operationId":"city_id","tags":["City"],"summary":"Fetch a city by its stable id","description":"Exact name, typeahead, nearest, or nearby cities. Full field reference: https://parseapi.com/docs/city","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"hierarchy","in":"query","required":false,"description":"Include the reviewed grain and immediate parent on each City. Unknown relationships are null.","schema":{"type":"boolean","const":true}},{"name":"format","in":"query","required":false,"description":"Use geojson for stored-center Features. Omit to retain this route’s default response.","schema":{"type":"string","enum":["geojson"]}},{"name":"id","in":"path","required":true,"description":"Stable city id from any city response","schema":{"type":"string","example":"city_mb8mbqrkz8zb"}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"deep","in":"query","required":false,"description":"Population, its known observation date and basis, area, elevation and capital status. Included automatically on paid plans in API 2.2.","schema":{"type":"boolean"}},{"name":"If-None-Match","in":"header","required":false,"description":"Validate a cached canonical response or relationship list. Matching validators return 304 without a body; ordinary request billing and rate limits still apply.","schema":{"type":"string"}},{"name":"romanized","in":"query","required":false,"description":"Include reviewed official romanized name_romanized and romanization_language. Missing or conflicting forms remain null; no ASCII-folding substitute. Available reviewed forms currently cover 20 Japanese whole-city aliases.","schema":{"type":"boolean","const":true}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"ETag":{"description":"Validator for the selected City representation and serving edition. Conditional HTTP reads can return 304. Ordinary pooled request billing and rate limits still apply.","schema":{"type":"string"}},"Cache-Control":{"description":"private, no-cache: retain a cached body but validate before reuse.","schema":{"type":"string","const":"private, no-cache"}},"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","latitude","longitude","timezone","id"],"properties":{"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"timezone":{"type":["string","null"]},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"id":{"type":["string","null"],"description":"Stable city identifier when available."}}},{"type":"object","required":["type","id","geometry","properties"],"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^city_[a-z0-9]{12}$"},"geometry":{"oneOf":[{"type":"null"},{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","const":"Point"},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number"},"description":"Longitude, latitude of the stored center."}}}]},"properties":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","timezone"],"properties":{"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"match":{"type":"object","required":["type","value","language"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"language":{"type":["string","null"]}}}},"additionalProperties":true}}},{"type":"object","required":["type","features","next_cursor"],"properties":{"type":{"type":"string","const":"FeatureCollection"},"features":{"type":"array","items":{"type":"object","required":["type","id","geometry","properties"],"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^city_[a-z0-9]{12}$"},"geometry":{"oneOf":[{"type":"null"},{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","const":"Point"},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number"},"description":"Longitude, latitude of the stored center."}}}]},"properties":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","timezone"],"properties":{"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"match":{"type":"object","required":["type","value","language"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"language":{"type":["string","null"]}}}},"additionalProperties":true}}}},"next_cursor":{"type":["string","null"],"description":"Opaque cursor for another page, or null at the end. Search and named nearby include this only with page=true or cursor."}},"additionalProperties":true}],"description":"Default response or GeoJSON. Complete City facts and stable identity."}},"application/geo+json":{"schema":{"type":"object","required":["type","id","geometry","properties"],"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^city_[a-z0-9]{12}$"},"geometry":{"oneOf":[{"type":"null"},{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","const":"Point"},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number"},"description":"Longitude, latitude of the stored center."}}}]},"properties":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","timezone"],"properties":{"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"match":{"type":"object","required":["type","value","language"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"language":{"type":["string","null"]}}}},"additionalProperties":true}}}}}},"304":{"description":"The selected canonical or catalog metadata representation is unchanged. No response body; ordinary request billing and rate limits apply.","headers":{"ETag":{"description":"Validator for the selected City representation and serving edition. Conditional HTTP reads can return 304. Ordinary pooled request billing and rate limits still apply.","schema":{"type":"string"}},"Cache-Control":{"description":"private, no-cache: retain a cached body but validate before reuse.","schema":{"type":"string","const":"private, no-cache"}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/city/{name}/nearby":{"get":{"operationId":"city_nearby","tags":["City"],"summary":"Cities around a named city","description":"Lists cities around a named anchor, nearest first by default, each with distance and distance_mi. Country and state select the anchor; type and grain select both anchor and results. Population, timezone and bbox filter results without disqualifying the anchor. Use page=true for cursors. Radius is a query dial, never a path segment. Default 40 km. Full field reference: https://parseapi.com/docs/city","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"type","in":"query","required":false,"description":"Filter the recorded place type, such as city or ward.","schema":{"type":"string","minLength":1,"maxLength":60}},{"name":"grain","in":"query","required":false,"description":"Filter a reviewed geographic layer. Unreviewed records do not match.","schema":{"type":"string","enum":["municipality","subdivision","locality","metropolitan_area"]}},{"name":"hierarchy","in":"query","required":false,"description":"Include the reviewed grain and immediate parent on each City. Unknown relationships are null.","schema":{"type":"boolean","const":true}},{"name":"aliases","in":"query","required":false,"description":"Also match reviewed official name forms. Applies to name lookup and search, without spelling correction.","schema":{"type":"boolean","const":true}},{"name":"ambiguity","in":"query","required":false,"description":"Require a unique eligible exact name match; otherwise return HTTP 409 ambiguous_city with up to two safe City candidates.","schema":{"type":"string","enum":["error"]}},{"name":"format","in":"query","required":false,"description":"Use geojson for stored-center Features. Omit to retain this route’s default response.","schema":{"type":"string","enum":["geojson"]}},{"name":"countries","in":"query","required":false,"description":"Comma-separated ISO2 country set; at most 50 distinct codes. Collection results must belong to this set.","schema":{"type":"string","minLength":2,"maxLength":149,"example":"JP,AT"}},{"name":"exclude_countries","in":"query","required":false,"description":"Comma-separated ISO2 countries excluded from collection results.","schema":{"type":"string","minLength":2,"maxLength":149}},{"name":"timezones","in":"query","required":false,"description":"Comma-separated exact IANA timezone set.","schema":{"type":"string","minLength":1,"maxLength":5049}},{"name":"min_elevation","in":"query","required":false,"description":"Inclusive minimum known elevation, in meters. Unknown values do not match.","schema":{"type":"number"}},{"name":"max_elevation","in":"query","required":false,"description":"Inclusive maximum known elevation, in meters; must be at least the minimum.","schema":{"type":"number"}},{"name":"min_population","in":"query","required":false,"description":"Inclusive minimum known population at the returned place layer. Unknown counts do not match.","schema":{"type":"integer","minimum":0,"maximum":9007199254740991}},{"name":"max_population","in":"query","required":false,"description":"Inclusive maximum known population. Must be at least min_population when both are supplied.","schema":{"type":"integer","minimum":0,"maximum":9007199254740991}},{"name":"bbox","in":"query","required":false,"description":"Place-center bounds west,south,east,north in degrees. West greater than east crosses the dateline. This does not test municipal boundary intersection.","schema":{"type":"string","example":"130,30,145,45"}},{"name":"page","in":"query","required":false,"description":"Include next_cursor on prefix search or named nearby. Browse and coordinate nearby always include it.","schema":{"type":"boolean","const":true}},{"name":"cursor","in":"query","required":false,"description":"Opaque next_cursor from the previous response. Keep the original query options, including limit, unchanged. Invalid or changed cursors return 400; restart without a cursor. Verified revision-reader pages bind to their immutable edition; restart after an edition change. Legacy-reader pages follow the current catalog.","schema":{"type":"string","minLength":1,"maxLength":700}},{"name":"sort","in":"query","required":false,"description":"Up to three keys: name, population, country, elevation; relevance for search and distance for nearby. Prefix a key with - for descending or + for ascending. Unknown values sort last.","schema":{"type":"string","maxLength":100,"example":"-population,name"}},{"name":"name","in":"path","required":true,"description":"Anchor city name","schema":{"type":"string","example":"denver"}},{"name":"country","in":"query","required":false,"description":"ISO country code to disambiguate the anchor","schema":{"type":"string","example":"US"}},{"name":"state","in":"query","required":false,"description":"State code such as FL or US-FL. Get codes from /country/{country}/states. State names return 400. A country prefix must match the country filter.","schema":{"type":"string","minLength":1,"maxLength":6,"pattern":"^(?:[A-Za-z]{2}-)?[A-Za-z0-9]{1,3}$","example":"FL"}},{"name":"radius","in":"query","required":false,"description":"Search radius (default 40 km, max 800 km / 500 mi)","schema":{"type":"number","example":8}},{"name":"unit","in":"query","required":false,"description":"Radius unit, km (default) or mi","schema":{"type":"string","enum":["km","mi"],"example":"mi"}},{"name":"limit","in":"query","required":false,"description":"Max results, default 10, max 50","schema":{"type":"integer","example":10}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"deep","in":"query","required":false,"description":"Population, its known observation date and basis, area, elevation and capital status. Included automatically on paid plans in API 2.2.","schema":{"type":"boolean"}},{"name":"If-None-Match","in":"header","required":false,"description":"Validate a cached canonical response or relationship list. Matching validators return 304 without a body; ordinary request billing and rate limits still apply.","schema":{"type":"string"}},{"name":"romanized","in":"query","required":false,"description":"Include reviewed official romanized name_romanized and romanization_language. Missing or conflicting forms remain null; no ASCII-folding substitute. Available reviewed forms currently cover 20 Japanese whole-city aliases.","schema":{"type":"boolean","const":true}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"ETag":{"description":"Validator for the selected City representation and serving edition. Conditional HTTP reads can return 304. Ordinary pooled request billing and rate limits still apply.","schema":{"type":"string"}},"Cache-Control":{"description":"private, no-cache: retain a cached body but validate before reuse.","schema":{"type":"string","const":"private, no-cache"}},"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","required":["city","state","country","radius","unit","nearby"],"properties":{"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"radius":{"type":"number"},"unit":{"type":"string","enum":["km","mi"]},"nearby":{"type":"array","items":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","latitude","longitude","timezone","id","distance","distance_mi"],"properties":{"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"id":{"type":["string","null"],"description":"Stable city identifier when available."}}}},"next_cursor":{"type":["string","null"],"description":"Opaque cursor for another page, or null at the end. Search and named nearby include this only with page=true or cursor."}}},{"type":"object","required":["type","id","geometry","properties"],"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^city_[a-z0-9]{12}$"},"geometry":{"oneOf":[{"type":"null"},{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","const":"Point"},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number"},"description":"Longitude, latitude of the stored center."}}}]},"properties":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","timezone"],"properties":{"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"match":{"type":"object","required":["type","value","language"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"language":{"type":["string","null"]}}}},"additionalProperties":true}}},{"type":"object","required":["type","features","next_cursor"],"properties":{"type":{"type":"string","const":"FeatureCollection"},"features":{"type":"array","items":{"type":"object","required":["type","id","geometry","properties"],"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^city_[a-z0-9]{12}$"},"geometry":{"oneOf":[{"type":"null"},{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","const":"Point"},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number"},"description":"Longitude, latitude of the stored center."}}}]},"properties":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","timezone"],"properties":{"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"match":{"type":"object","required":["type","value","language"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"language":{"type":["string","null"]}}}},"additionalProperties":true}}}},"next_cursor":{"type":["string","null"],"description":"Opaque cursor for another page, or null at the end. Search and named nearby include this only with page=true or cursor."}},"additionalProperties":true}],"description":"Default response or GeoJSON. Complete City facts and stable identity."}},"application/geo+json":{"schema":{"type":"object","required":["type","features","next_cursor"],"properties":{"type":{"type":"string","const":"FeatureCollection"},"features":{"type":"array","items":{"type":"object","required":["type","id","geometry","properties"],"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^city_[a-z0-9]{12}$"},"geometry":{"oneOf":[{"type":"null"},{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","const":"Point"},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number"},"description":"Longitude, latitude of the stored center."}}}]},"properties":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","timezone"],"properties":{"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"match":{"type":"object","required":["type","value","language"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"language":{"type":["string","null"]}}}},"additionalProperties":true}}}},"next_cursor":{"type":["string","null"],"description":"Opaque cursor for another page, or null at the end. Search and named nearby include this only with page=true or cursor."}},"additionalProperties":true}}}},"304":{"description":"The selected canonical or catalog metadata representation is unchanged. No response body; ordinary request billing and rate limits apply.","headers":{"ETag":{"description":"Validator for the selected City representation and serving edition. Conditional HTTP reads can return 304. Ordinary pooled request billing and rate limits still apply.","schema":{"type":"string"}},"Cache-Control":{"description":"private, no-cache: retain a cached body but validate before reuse.","schema":{"type":"string","const":"private, no-cache"}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"ambiguous_city with bounded safe identity choices when ambiguity=error.","content":{"application/json":{"schema":{"type":"object","required":["code","message","candidates"],"properties":{"code":{"type":"string","const":"ambiguous_city"},"message":{"type":"string"},"candidates":{"type":"array","maxItems":2,"items":{"type":"object","required":["id","object"],"properties":{"id":{"type":"string"},"object":{"type":"string","const":"city"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"type":{"type":["string","null"]}},"additionalProperties":false}}},"additionalProperties":true}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/postal/{code}":{"get":{"operationId":"postal","tags":["Postal"],"summary":"Look up a postal or ZIP code","description":"city, state_name, and county_name are English or an official romanization when a trusted source has them, native otherwise. city_local, state_name_local, and county_name_local carry the native form when it differs. Null when absent or the same as the primary field. Unique codes resolve without ?country=. A collision 404s asking for it. Never defaults to US. Paid deep adds a combined US ZIP sales tax reference in tax.name, tax.rate, and the tax.rate_state, tax.rate_county, tax.rate_city and tax.rate_special components. Rates are percentages: 7.9 means 7.9%. The total includes its components. 0 is known zero; null is unavailable. An exact address can have a different rate. Choose the geographic reference for the task. Australian suburb/locality choices from the August 2026 reference. Each option carries its own state. Null outside the reviewed reference; [] means a reviewed postcode has no eligible choices. One option does not establish an unambiguous city: use city for autofill and localities for explicit selection. Geographic reference, not mailing-address verification. US and qualified territory/FAS ZIP type is standard, po_box, unique, military or null. A ZIP identity does not verify address deliverability. US ZIP metropolitan and micropolitan area associations. Null when unsupported or unverified; [] only when complete observations place the ZIP outside every CBSA. Sorted by descending share_percent (null last), then code. Percentages are not renormalized. Full field reference: https://parseapi.com/docs/postal","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"code","in":"path","required":true,"description":"Postal or ZIP code. Unique codes resolve bare (SW1A 1AA). Use ?country=JP for 100-0001, whose digits also occur in Portugal.","schema":{"type":"string","example":"SW1A 1AA"}},{"name":"country","in":"query","required":false,"description":"ISO2, ISO3, or a country name. Optional when the code exists in exactly one covered country. Both five-digit and seven-digit codes can collide.","schema":{"type":"string","example":"US"}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"deep","in":"query","required":false,"description":"Population, area, elevation, tax references, nearby postal codes and metropolitan areas. Included automatically on paid plans in API 2.2.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"postal":{"type":"string"},"city":{"type":["string","null"]},"city_local":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"county_name_local":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"state_name_local":{"type":["string","null"]},"country":{"type":"string"},"country_name":{"type":["string","null"]},"type":{"type":["string","null"],"description":"US or qualified territory/FAS ZIP type; omitted elsewhere. Accept future string values."},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"timezone":{"type":["string","null"]},"elevation":{"type":["number","null"]},"elevation_ft":{"type":["number","null"]},"population":{"type":["integer","null"]},"area":{"type":["number","null"]},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"currency":{"type":["string","null"]},"neighbors":{"type":"array","items":{"type":"string"}},"tax":{"type":"object","properties":{"name":{"type":["string","null"]},"rate":{"type":["number","null"]},"rate_state":{"type":["number","null"]},"rate_county":{"type":["number","null"]},"rate_city":{"type":["number","null"]},"rate_special":{"type":["number","null"]}},"required":["name","rate","rate_state","rate_county","rate_city","rate_special"],"additionalProperties":true},"metros":{"type":["array","null"],"items":{"type":"object","properties":{"code":{"type":"string","pattern":"^(?!(?:00000|99999)$)[0-9]{5}$","description":"Five-digit CBSA code"},"name":{"type":"string","description":"Metropolitan or micropolitan statistical area name"},"type":{"type":"string","enum":["metropolitan","micropolitan"],"description":"metropolitan or micropolitan"},"share_percent":{"type":["number","null"],"minimum":0,"maximum":100,"description":"Percentage of all addresses in the ZIP associated with this area, from 0 to 100; 100 means all addresses. Decimal values are supported; null when unknown"}},"required":["code","name","type","share_percent"],"additionalProperties":true},"description":"US ZIP metropolitan and micropolitan area associations. Null when unsupported or unverified; [] only when complete observations place the ZIP outside every CBSA. Sorted by descending share_percent (null last), then code. Percentages are not renormalized."},"property_tax":{"type":["object","null"],"properties":{"annual_median":{"type":"integer","minimum":0}},"required":["annual_median"],"additionalProperties":true,"description":"Current median annual property tax; currency is inherited from currency."},"localities":{"type":["array","null"],"items":{"type":"object","properties":{"city":{"type":"string","description":"Source suburb or locality name."},"state":{"type":"string","description":"Australian state or territory abbreviation for this option."},"state_name":{"type":"string","description":"English state or territory name for this option; independent of lang."}},"required":["city","state","state_name"],"additionalProperties":false},"description":"Australian suburb/locality choices from the August 2026 reference. Each option carries its own state. Null outside the reviewed reference; [] means a reviewed postcode has no eligible choices. One option does not establish an unambiguous city: use city for autofill and localities for explicit selection. Geographic reference, not mailing-address verification."}},"required":["postal","city","city_local","county","county_name","county_name_local","state","state_name","state_name_local","country","country_name","latitude","longitude","timezone","localities"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/postal/{code}/nearby":{"get":{"operationId":"postal_nearby","tags":["Postal"],"summary":"Nearby postal codes","description":"Postal codes around a given one, nearest first, with distance and distance_mi. Default radius 40 km. Unique codes resolve without ?country=. A collision 404s asking for it. US ZIP metropolitan and micropolitan area associations. Null when unsupported or unverified; [] only when complete observations place the ZIP outside every CBSA. Sorted by descending share_percent (null last), then code. Percentages are not renormalized. Full field reference: https://parseapi.com/docs/postal","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"code","in":"path","required":true,"description":"Postal or ZIP code to search around","schema":{"type":"string","example":"SW1A 1AA"}},{"name":"country","in":"query","required":false,"description":"ISO2, ISO3, or a country name. Optional when the code is unique.","schema":{"type":"string","example":"GB"}},{"name":"radius","in":"query","required":false,"description":"Search radius (default 40 km)","schema":{"type":"number","example":40}},{"name":"unit","in":"query","required":false,"description":"Radius unit, km (default) or mi","schema":{"type":"string","enum":["km","mi"],"example":"km"}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"deep","in":"query","required":false,"description":"Population, area, elevation, tax references, nearby postal codes and metropolitan areas. Included automatically on paid plans in API 2.2.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"postal":{"type":"string"},"country":{"type":"string"},"radius":{"type":"number"},"unit":{"type":"string"},"nearby":{"type":"array","items":{"type":"object","properties":{"postal":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"distance":{"type":"number"},"distance_mi":{"type":"number"},"metros":{"type":["array","null"],"items":{"type":"object","properties":{"code":{"type":"string","pattern":"^(?!(?:00000|99999)$)[0-9]{5}$","description":"Five-digit CBSA code"},"name":{"type":"string","description":"Metropolitan or micropolitan statistical area name"},"type":{"type":"string","enum":["metropolitan","micropolitan"],"description":"metropolitan or micropolitan"},"share_percent":{"type":["number","null"],"minimum":0,"maximum":100,"description":"Percentage of all addresses in the ZIP associated with this area, from 0 to 100; 100 means all addresses. Decimal values are supported; null when unknown"}},"required":["code","name","type","share_percent"],"additionalProperties":true},"description":"US ZIP metropolitan and micropolitan area associations. Null when unsupported or unverified; [] only when complete observations place the ZIP outside every CBSA. Sorted by descending share_percent (null last), then code. Percentages are not renormalized."}},"required":["postal","city","state","country","distance","distance_mi"],"additionalProperties":true}},"metros":{"type":["array","null"],"items":{"type":"object","properties":{"code":{"type":"string","pattern":"^(?!(?:00000|99999)$)[0-9]{5}$","description":"Five-digit CBSA code"},"name":{"type":"string","description":"Metropolitan or micropolitan statistical area name"},"type":{"type":"string","enum":["metropolitan","micropolitan"],"description":"metropolitan or micropolitan"},"share_percent":{"type":["number","null"],"minimum":0,"maximum":100,"description":"Percentage of all addresses in the ZIP associated with this area, from 0 to 100; 100 means all addresses. Decimal values are supported; null when unknown"}},"required":["code","name","type","share_percent"],"additionalProperties":true},"description":"US ZIP metropolitan and micropolitan area associations. Null when unsupported or unverified; [] only when complete observations place the ZIP outside every CBSA. Sorted by descending share_percent (null last), then code. Percentages are not renormalized."}},"required":["postal","country","radius","unit","nearby"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/postal/{code}/distance/{other}":{"get":{"operationId":"postal_distance","tags":["Postal"],"summary":"Distance between two postal codes","description":"Straight-line distance in miles and km. Unique codes resolve without ?country=. Both codes must be in the same country. US ZIP metropolitan and micropolitan area associations. Null when unsupported or unverified; [] only when complete observations place the ZIP outside every CBSA. Sorted by descending share_percent (null last), then code. Percentages are not renormalized. Full field reference: https://parseapi.com/docs/postal","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"code","in":"path","required":true,"description":"First postal or ZIP code","schema":{"type":"string","example":"SW1A 1AA"}},{"name":"other","in":"path","required":true,"description":"Second postal or ZIP code","schema":{"type":"string","example":"EC1A 1BB"}},{"name":"country","in":"query","required":false,"description":"ISO2, ISO3, or a country name. Optional when the first code is unique.","schema":{"type":"string","example":"GB"}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"deep","in":"query","required":false,"description":"Population, area, elevation, tax references, nearby postal codes and metropolitan areas. Included automatically on paid plans in API 2.2.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"string"},"from":{"type":"object","properties":{"postal":{"type":"string"},"city":{"type":["string","null"]},"metros":{"type":["array","null"],"items":{"type":"object","properties":{"code":{"type":"string","pattern":"^(?!(?:00000|99999)$)[0-9]{5}$","description":"Five-digit CBSA code"},"name":{"type":"string","description":"Metropolitan or micropolitan statistical area name"},"type":{"type":"string","enum":["metropolitan","micropolitan"],"description":"metropolitan or micropolitan"},"share_percent":{"type":["number","null"],"minimum":0,"maximum":100,"description":"Percentage of all addresses in the ZIP associated with this area, from 0 to 100; 100 means all addresses. Decimal values are supported; null when unknown"}},"required":["code","name","type","share_percent"],"additionalProperties":true},"description":"US ZIP metropolitan and micropolitan area associations. Null when unsupported or unverified; [] only when complete observations place the ZIP outside every CBSA. Sorted by descending share_percent (null last), then code. Percentages are not renormalized."}},"required":["postal","city"],"additionalProperties":true},"to":{"type":"object","properties":{"postal":{"type":"string"},"city":{"type":["string","null"]},"metros":{"type":["array","null"],"items":{"type":"object","properties":{"code":{"type":"string","pattern":"^(?!(?:00000|99999)$)[0-9]{5}$","description":"Five-digit CBSA code"},"name":{"type":"string","description":"Metropolitan or micropolitan statistical area name"},"type":{"type":"string","enum":["metropolitan","micropolitan"],"description":"metropolitan or micropolitan"},"share_percent":{"type":["number","null"],"minimum":0,"maximum":100,"description":"Percentage of all addresses in the ZIP associated with this area, from 0 to 100; 100 means all addresses. Decimal values are supported; null when unknown"}},"required":["code","name","type","share_percent"],"additionalProperties":true},"description":"US ZIP metropolitan and micropolitan area associations. Null when unsupported or unverified; [] only when complete observations place the ZIP outside every CBSA. Sorted by descending share_percent (null last), then code. Percentages are not renormalized."}},"required":["postal","city"],"additionalProperties":true},"distance":{"type":"number"},"distance_mi":{"type":"number"}},"required":["country","from","to","distance","distance_mi"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/address/{address}":{"get":{"operationId":"address","tags":["Address"],"summary":"Look up a US address","description":"Checks a US address against official records. registered means a record match, not postal deliverability. Junk returns 200 with valid false. Full field reference: https://parseapi.com/docs/address","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"country","in":"query","required":false,"description":"Address country. Current published coverage is US; defaults to US.","schema":{"type":"string","example":"US"}},{"name":"address","in":"path","required":true,"description":"Freeform US address, URL-encoded","schema":{"type":"string","example":"152 200th Avenue, Ellsworth MN"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"address":{"type":["string","null"]},"valid":{"type":"boolean"},"registered":{"type":["boolean","null"]},"number":{"type":["string","null"]},"street":{"type":["string","null"]},"unit":{"type":["string","null"]},"postal":{"type":["string","null"]},"city":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]}},"required":["address","valid","registered","number","street","unit","city","county","county_name","state","state_name","postal","country","country_name","latitude","longitude"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/address":{"get":{"operationId":"address_autocomplete","tags":["Address"],"summary":"Autocomplete a partial US address","description":"Ranked suggestions from official US records. Pass postal or city and state from the form when you have them, otherwise the caller's IP ranks the home city first. Suggestions never invent house numbers. Full field reference: https://parseapi.com/docs/address","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"country","in":"query","required":false,"description":"Address country. Current published coverage is US; defaults to US.","schema":{"type":"string","example":"US"}},{"name":"q","in":"query","required":true,"description":"The partial address as typed","schema":{"type":"string","example":"200th"}},{"name":"postal","in":"query","required":false,"description":"Postal code scope from the form","schema":{"type":"string","example":"56129"}},{"name":"city","in":"query","required":false,"description":"City scope; pair with state for the US","schema":{"type":"string","example":"Greensboro"}},{"name":"state","in":"query","required":false,"description":"US state code","schema":{"type":"string","example":"NC"}},{"name":"ip","in":"query","required":false,"description":"End-user IP for ranking bias when calling server-side","schema":{"type":"string","example":"1.2.3.4"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"q":{"type":"string"},"postal":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"addresses":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"number":{"type":["string","null"]},"street":{"type":["string","null"]},"unit":{"type":["string","null"]},"postal":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]}},"required":["address","number","street","unit","city","state","postal","latitude","longitude"],"additionalProperties":true}},"reason":{"type":["string","null"],"description":"Null when suggestions exist. more_input asks for more street input; missing_context asks for a postal code or city and state; no_matches means the completed search found nothing. Additional reasons may be added. Unavailable search services return 503."}},"required":["q","addresses","reason"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/email/{email}":{"get":{"operationId":"email","tags":["Email"],"summary":"Check an email address","description":"Check syntax, consumer mailbox, disposable and role addresses, reserved domain type, typo suggestions and domain mail routing. Uses one pooled request. To verify a mailbox, explicitly call POST /email/verify. deep=true is rejected in API 2.1. Full field reference: https://parseapi.com/docs/email","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"email","in":"path","required":true,"description":"Email address","schema":{"type":"string","format":"email","example":"test@example.com"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"didyoumean":{"type":["string","null"]},"valid":{"type":"boolean"},"free":{"type":"boolean"},"domain":{"type":["string","null"]},"domain_type":{"anyOf":[{"const":"academic","type":"string"},{"const":"government","type":"string"},{"const":"military","type":"string"},{"type":"null"}]},"domain_valid":{"type":["boolean","null"]},"role":{"type":"boolean"},"disposable":{"type":"boolean"}},"required":["email","didyoumean","valid","free","domain","domain_type","domain_valid","role","disposable"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/email/verify":{"post":{"operationId":"email_verify","tags":["Email"],"summary":"Verify an email mailbox","description":"Explicit mailbox verification. Send an email string in a JSON body. Returns the complete ordinary email answer plus mailbox and address details at the root. Requires Email verification access and a secret or domain-restricted public key; app keys are rejected. Reuses existing check freshness and billing rules. An incomplete mailbox check leaves verdict fields null and is not billed. Suggested first names are not verified identity. No automatic retries by default. Full field reference: https://parseapi.com/docs/email","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"additionalProperties":false,"properties":{"email":{"type":"string","format":"email"}}},"example":{"email":"jane+news@mit.edu"}}}},"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"didyoumean":{"type":["string","null"]},"valid":{"type":"boolean"},"free":{"type":"boolean"},"domain":{"type":["string","null"]},"domain_type":{"anyOf":[{"const":"academic","type":"string"},{"const":"government","type":"string"},{"const":"military","type":"string"},{"type":"null"}]},"domain_valid":{"type":["boolean","null"]},"role":{"type":"boolean"},"disposable":{"type":"boolean"},"first_name":{"type":["string","null"]},"no_reply":{"type":["boolean","null"]},"tag":{"type":["string","null"]},"mail_provider":{"type":["string","null"]},"deliverable":{"type":["boolean","null"]},"catchall":{"type":["boolean","null"]},"status":{"type":["string","null"]},"reason":{"type":["string","null"]}},"required":["email","didyoumean","valid","free","domain","domain_type","domain_valid","role","disposable","first_name","no_reply","tag","mail_provider","deliverable","catchall","status","reason"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/card/{bin}":{"get":{"operationId":"card","tags":["Card"],"summary":"Identify a card network and its logo","description":"Send 2–11 leading digits as a string. Core returns brand, brand_name and a CDN SVG logo independently of issuer coverage. Unknown or ambiguous brands use null fields and a generic logo. Optional deep=true adds recorded issuer details; six or more digits enable directory matching. The longest recorded prefix wins including its null fields, with no parent backfill. Coverage is partial and does not prove card validity or payment acceptance. Core uses one pooled request on every plan. Optional Deep is included on paid plans in the same request; existing accounts retain their current Deep access. Never send a full card number. Full field reference: https://parseapi.com/docs/card","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"bin","in":"path","required":true,"description":"Processor-provided BIN/IIN prefix with 2 to 11 ASCII digits as a string, up to 64 characters before normalization. Only ASCII space, tab, CR, LF and hyphen separators are removed. Preserve leading zeros","schema":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[ \\t\\r\\n-]*(?:[0-9][ \\t\\r\\n-]*){2,11}$","example":"43737400"}},{"name":"deep","in":"query","required":false,"description":"Recorded issuer details and the actual matched prefix. Partial coverage; unknown fields stay null. Included automatically on paid plans in API 2.2. Existing accounts retain their current profile access.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Link":{"description":"Link to the applicable data attribution and license notice at https://parseapi.com/legal/attribution#bin","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["bin","brand","brand_name","logo"],"additionalProperties":true,"properties":{"bin":{"type":"string","pattern":"^[0-9]{2,11}$","description":"Normalized input. Leading zeros are preserved"},"brand":{"type":["string","null"],"description":"Network key from reviewed prefix rules, or null when unknown or ambiguous"},"logo":{"type":"string","format":"uri","description":"CDN SVG URL; generic when brand is unknown, ambiguous or has no reviewed artwork"},"brand_name":{"type":["string","null"],"description":"Display name for brand, or null when brand is null"},"prefix":{"type":["string","null"],"description":"Longest actual matching prefix, which may be shorter than bin. Null when no record matches"},"issuer":{"type":["string","null"],"description":"Recorded issuer name, or null when unavailable"},"country":{"type":["string","null"],"description":"Recorded issuer country, ISO 3166-1 alpha-2. Null when unavailable"},"type":{"type":["string","null"],"description":"Recorded card type, such as credit, debit, or charge. Null when unavailable or mixed"},"prepaid":{"type":["boolean","null"],"description":"Explicit known prepaid status. Null means unknown, not false"}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/phone/{number}":{"get":{"operationId":"phone","tags":["Phone"],"summary":"Validate and format a phone number","description":"Validate and format a number. 246 countries and regions. Full field reference: https://parseapi.com/docs/phone","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"number","in":"path","required":true,"description":"Phone number (E.164 preferred)","schema":{"type":"string","example":"+14155552671"}},{"name":"country","in":"query","required":false,"description":"Default region for national formats without a leading +","schema":{"type":"string","example":"US"}},{"name":"deep","in":"query","required":false,"description":"Numbering-plan state and timezone, when known. Included automatically on paid plans in API 2.2. Existing accounts retain their current profile access.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":["string","null"]},"valid":{"type":"boolean"},"country":{"type":["string","null"]},"type":{"anyOf":[{"const":"mobile","type":"string"},{"const":"landline","type":"string"},{"const":"toll_free","type":"string"},{"const":"unknown","type":"string"},{"type":"null"}]},"national":{"type":["string","null"]},"international":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"timezone":{"type":["string","null"]}},"required":["phone","valid","country","type","national","international"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/carrier/{number}":{"get":{"operationId":"carrier","tags":["Carrier"],"summary":"Carrier and line type for a phone number","description":"Who serves a number: carrier, line type, and burner. Full field reference: https://parseapi.com/docs/carrier","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"number","in":"path","required":true,"description":"Phone number (E.164 preferred)","schema":{"type":"string","example":"+12127365000"}},{"name":"country","in":"query","required":false,"description":"Default region for national formats without a leading +","schema":{"type":"string","example":"US"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":["string","null"]},"valid":{"type":"boolean"},"country":{"type":["string","null"]},"type":{"anyOf":[{"const":"mobile","type":"string"},{"const":"landline","type":"string"},{"const":"voip","type":"string"},{"const":"toll_free","type":"string"},{"const":"unknown","type":"string"},{"type":"null"}]},"carrier":{"type":["string","null"]},"burner":{"type":["boolean","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]}},"required":["phone","valid","country","type","carrier","burner","city","state","state_name"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/caller/{number}":{"get":{"operationId":"caller","tags":["Caller"],"summary":"Caller ID (CNAM) for a phone number","description":"The registered caller ID (CNAM) for a number. Full field reference: https://parseapi.com/docs/caller","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"number","in":"path","required":true,"description":"Phone number (E.164 preferred)","schema":{"type":"string","example":"+18004633339"}},{"name":"country","in":"query","required":false,"description":"Default region for national formats without a leading +","schema":{"type":"string","example":"US"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":["string","null"]},"valid":{"type":"boolean"},"country":{"type":["string","null"]},"caller":{"type":["string","null"]}},"required":["phone","valid","country","caller"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/hlr/{number}":{"get":{"operationId":"hlr","tags":["HLR"],"summary":"Phone assignment and reachability at the last network check","description":"live and connected describe the last network check. Results may be reused; this is not a current handset-presence signal. Null fields mean the check did not establish an answer. Full field reference: https://parseapi.com/docs/hlr","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"number","in":"path","required":true,"description":"Phone number (E.164 preferred)","schema":{"type":"string","example":"+14156226819"}},{"name":"country","in":"query","required":false,"description":"Default region for national formats without a leading +","schema":{"type":"string","example":"US"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":["string","null"]},"valid":{"type":"boolean"},"country":{"type":["string","null"]},"live":{"type":["boolean","null"]},"connected":{"type":["boolean","null"]},"roaming":{"type":["boolean","null"]},"roaming_network":{"type":["string","null"]},"roaming_country":{"type":["string","null"]},"network":{"type":["string","null"]},"original_network":{"type":["string","null"]},"mcc":{"type":["string","null"]},"mnc":{"type":["string","null"]}},"required":["phone","valid","country","live","connected","roaming","roaming_network","roaming_country","network","original_network","mcc","mnc"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/stack/{domain}":{"get":{"operationId":"stack","tags":["Stack"],"summary":"Identify a website’s technologies","description":"One request on every plan. Returns category arrays for cms, servers, frameworks, ecommerce, analytics, chat, payments and hosting. Each entry has technology, name and nullable version. The API checks static homepage HTML and response headers. Successful results may be reused for 24 hours with the original checked_at time. An unsuccessful check returns HTTP 200 with checked_at and category arrays null. Empty arrays mean no category match on checked pages. Missing signatures do not establish absence. Use API version 2.2.0. Full field reference: https://parseapi.com/docs/stack","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"domain","in":"path","required":true,"description":"Public hostname only, including an optional subdomain. Internationalized names and a trailing dot are accepted. URLs, paths, ports, IP addresses and private names return 400.","schema":{"type":"string","maxLength":254,"example":"parseapi.com"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["domain","url","checked_at","cms","servers","frameworks","ecommerce","analytics","chat","payments","hosting"],"properties":{"domain":{"type":"string","description":"Requested public hostname, normalized to lowercase ASCII."},"url":{"type":"string","format":"uri","description":"Homepage URL after redirects, with query and fragment omitted; requested HTTPS URL if no homepage response was received."},"checked_at":{"type":["string","null"],"format":"date-time","description":"Time of the recorded inventory. Cached responses preserve it. Null when the check did not complete."},"cms":{"type":["array","null"],"description":"Detected CMS platforms and site builders. Empty when none matched the homepage; null when the homepage could not be checked.","items":{"type":"object","required":["technology","name","version"],"additionalProperties":false,"properties":{"technology":{"type":"string","description":"Stable technology code, such as wordpress or nextjs."},"name":{"type":"string","description":"Display name."},"version":{"type":["string","null"],"description":"Explicit detected version. Null when absent or conflicting."}}}},"servers":{"type":["array","null"],"description":"Detected web servers. Empty when none matched the homepage; null when the homepage could not be checked.","items":{"type":"object","required":["technology","name","version"],"additionalProperties":false,"properties":{"technology":{"type":"string","description":"Stable technology code, such as wordpress or nextjs."},"name":{"type":"string","description":"Display name."},"version":{"type":["string","null"],"description":"Explicit detected version. Null when absent or conflicting."}}}},"frameworks":{"type":["array","null"],"description":"Detected frameworks. Empty when none matched the homepage; null when the homepage could not be checked.","items":{"type":"object","required":["technology","name","version"],"additionalProperties":false,"properties":{"technology":{"type":"string","description":"Stable technology code, such as wordpress or nextjs."},"name":{"type":"string","description":"Display name."},"version":{"type":["string","null"],"description":"Explicit detected version. Null when absent or conflicting."}}}},"ecommerce":{"type":["array","null"],"description":"Detected ecommerce platforms. Empty when none matched the homepage; null when the homepage could not be checked.","items":{"type":"object","required":["technology","name","version"],"additionalProperties":false,"properties":{"technology":{"type":"string","description":"Stable technology code, such as wordpress or nextjs."},"name":{"type":"string","description":"Display name."},"version":{"type":["string","null"],"description":"Explicit detected version. Null when absent or conflicting."}}}},"analytics":{"type":["array","null"],"description":"Detected analytics tools. Empty when none matched the homepage; null when the homepage could not be checked.","items":{"type":"object","required":["technology","name","version"],"additionalProperties":false,"properties":{"technology":{"type":"string","description":"Stable technology code, such as wordpress or nextjs."},"name":{"type":"string","description":"Display name."},"version":{"type":["string","null"],"description":"Explicit detected version. Null when absent or conflicting."}}}},"chat":{"type":["array","null"],"description":"Detected chat tools. Empty when none matched the homepage; null when the homepage could not be checked.","items":{"type":"object","required":["technology","name","version"],"additionalProperties":false,"properties":{"technology":{"type":"string","description":"Stable technology code, such as wordpress or nextjs."},"name":{"type":"string","description":"Display name."},"version":{"type":["string","null"],"description":"Explicit detected version. Null when absent or conflicting."}}}},"payments":{"type":["array","null"],"description":"Detected payment tools. Empty when none matched the homepage; null when the homepage could not be checked.","items":{"type":"object","required":["technology","name","version"],"additionalProperties":false,"properties":{"technology":{"type":"string","description":"Stable technology code, such as wordpress or nextjs."},"name":{"type":"string","description":"Display name."},"version":{"type":["string","null"],"description":"Explicit detected version. Null when absent or conflicting."}}}},"hosting":{"type":["array","null"],"description":"Detected hosting and edge services. Empty when none matched the homepage; null when the homepage could not be checked.","items":{"type":"object","required":["technology","name","version"],"additionalProperties":false,"properties":{"technology":{"type":"string","description":"Stable technology code, such as wordpress or nextjs."},"name":{"type":"string","description":"Display name."},"version":{"type":["string","null"],"description":"Explicit detected version. Null when absent or conflicting."}}}}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/company":{"get":{"operationId":"company_search","tags":["Company"],"summary":"Search companies by name, website, ticker or identifier","description":"Search the fixed cohort of 500 leading U.S. public-company issuers using q, domain, ticker or SEC CIK identifier. Discover by incorporation country or an exact industry and industry_type pair. Filters intersect and can narrow a selector. State registration discovery is not part of this cohort. Filter-only results use stable ID order and match:{field:\"filters\",value:null}. Returns company profiles and a continuation cursor. Paid plans include additional details on each company automatically. An empty list means no match in the directory edition. Use API version 2.2.0. Full field reference: https://parseapi.com/docs/company","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"q","in":"query","required":false,"description":"Company name or alias text. Use at most one of q, domain, ticker or identifier; without a selector, country or an industry pair is required. Name matches rank by exact name, prefix, then substring. Filter-only results use stable ID order.","schema":{"type":"string","minLength":1,"maxLength":300,"example":"Apple Inc."}},{"name":"domain","in":"query","required":false,"description":"Website hostname or HTTP(S) URL. Matches the exact normalized host, including subdomains; a conventional www. prefix is removed.","schema":{"type":"string","minLength":1,"maxLength":4096,"example":"apple.com"}},{"name":"ticker","in":"query","required":false,"description":"Exact ticker symbol, case-insensitive. Use exchange to narrow the listing.","schema":{"type":"string","minLength":1,"maxLength":64,"example":"AAPL"}},{"name":"identifier","in":"query","required":false,"description":"SEC CIK as a string, with or without leading zeros. The optional authority is sec.","schema":{"type":"string","minLength":1,"maxLength":256,"example":"0000320193"}},{"name":"country","in":"query","required":false,"description":"Filter the profile country by ISO 3166-1 alpha-2 code. Case-insensitive.","schema":{"type":"string","pattern":"^[A-Za-z]{2}$","example":"US"}},{"name":"industry","in":"query","required":false,"description":"Exact four-digit SIC industry code. Requires industry_type=sic. Matches recorded classifications only; no inferred classifications or prefix matching.","schema":{"type":"string","pattern":"^[0-9]{4}$","example":"7372"}},{"name":"industry_type","in":"query","required":false,"description":"Industry classification namespace. Currently sic; requires industry.","schema":{"type":"string","enum":["sic"]}},{"name":"exchange","in":"query","required":false,"description":"Exchange name, case-insensitive. Supported only with ticker.","schema":{"type":"string","minLength":1,"maxLength":128,"example":"Nasdaq"}},{"name":"authority","in":"query","required":false,"description":"Identifier authority, case-insensitive. Supported only with identifier.","schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_.:/-]{0,127}$","example":"sec"}},{"name":"limit","in":"query","required":false,"description":"Maximum companies per page.","schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"cursor","in":"query","required":false,"description":"Opaque next cursor from the previous response. Keep the selector, filters and limit unchanged. An invalid or expired cursor returns 400; restart the search.","schema":{"type":"string","minLength":1,"maxLength":1024}},{"name":"deep","in":"query","required":false,"description":"Add available business details, identifiers, industry and dated employee counts on each profile. Included on paid plans in the same pooled request. Existing accounts retain their current Deep access. Omit or use false for Core.","schema":{"type":"boolean","default":false}},{"name":"pretty","in":"query","required":false,"description":"Format the JSON response for reading.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","required":["companies","next"],"properties":{"companies":{"type":"array","maxItems":50,"items":{"type":"object","required":["id","name","country","website","listings","address","match"],"properties":{"id":{"type":"string","pattern":"^co_[23456789abcdefghjkmnpqrstuvwxyz]{12}$","description":"Stable company ID."},"name":{"type":"string","minLength":1,"description":"Primary company name."},"country":{"type":["string","null"],"pattern":"^[A-Z]{2}$","description":"Recorded incorporation country in ISO 3166-1 alpha-2 form. It does not establish headquarters or operations and may differ from an address country."},"website":{"type":["string","null"],"format":"uri","description":"Recorded company website URL, or null when unknown. A domain alone does not establish a URL."},"listings":{"type":"array","description":"Exchange and symbol pairs. An empty array does not establish private ownership.","items":{"type":"object","required":["exchange","symbol"],"properties":{"exchange":{"type":"string","minLength":1,"description":"Recorded exchange name, not an ISO market identifier code (MIC)."},"symbol":{"type":"string","minLength":1}}}},"address":{"type":["object","null"],"required":["type","street","city","state","postal","country"],"properties":{"type":{"type":"string","enum":["registered","headquarters","business","mailing"]},"street":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"],"description":"State or region in ParseAPI's public form: uppercase, without a country prefix. Null when unknown."},"postal":{"type":["string","null"]},"country":{"type":["string","null"],"pattern":"^[A-Z]{2}$","description":"Address country. It may differ from the company country."}},"description":"One recorded address: headquarters first, then business, registered or mailing. The first recorded address of the selected type is returned, preserving its type. Null when no address is recorded."},"match":{"oneOf":[{"type":"object","required":["field","value"],"properties":{"field":{"type":"string","enum":["name","legal_name","aliases","website","domains"]},"value":{"type":"string","minLength":1}}},{"type":"object","required":["field","value","type","authority"],"properties":{"field":{"type":"string","const":"identifiers"},"value":{"type":"string","minLength":1},"type":{"type":"string","minLength":1},"authority":{"type":"string","minLength":1}}},{"type":"object","required":["field","value","exchange"],"properties":{"field":{"type":"string","const":"listings"},"value":{"type":"string","minLength":1},"exchange":{"type":"string","minLength":1,"description":"Recorded exchange name for this matched symbol."}}},{"type":"object","required":["field","value"],"additionalProperties":false,"properties":{"field":{"type":"string","const":"filters"},"value":{"type":"null"}}}]},"legal_name":{"type":["string","null"],"description":"Different legal entity name; omitted when it repeats the core name or is unknown."},"aliases":{"type":"array","items":{"type":"string","minLength":1}},"jurisdiction":{"type":["object","null"],"required":["country","state"],"description":"Recorded registration jurisdiction. Country and state are separate; an unknown state is null. The whole object is null when the jurisdiction is unknown.","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 registration country."},"state":{"type":["string","null"],"description":"Registration subdivision in ParseAPI's public state code form without the country prefix, or null for a country-only jurisdiction."}}},"status":{"type":["string","null"],"description":"Recorded legal entity status. Does not establish current business activity, website availability or listing status."},"domains":{"type":"array","description":"Other associated domains, excluding the hostname of the core website. If the core URL is unknown, all recorded hostnames appear here with null URLs.","items":{"type":"object","required":["domain","url"],"properties":{"domain":{"type":"string","minLength":1,"description":"Lowercase ASCII hostname with a conventional www. prefix removed."},"url":{"type":["string","null"],"format":"uri","description":"Recorded HTTP(S) URL for this exact normalized hostname, or null when unknown."}}}},"identifiers":{"type":"array","description":"Identifiers paired with their issuing authority. Values remain strings, including leading zeros.","items":{"type":"object","required":["type","authority","value"],"properties":{"type":{"type":"string","minLength":1},"authority":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}}}},"incorporated":{"type":["string","null"],"format":"date","description":"Legal entity incorporation date, distinct from brand founding."},"addresses":{"type":"array","description":"Other recorded addresses, excluding the selected core address and retaining their recorded order. Omitted when no additional address is recorded.","items":{"type":"object","required":["type","street","city","state","postal","country"],"properties":{"type":{"type":"string","enum":["registered","headquarters","business","mailing"]},"street":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"],"description":"State or region in ParseAPI's public form: uppercase, without a country prefix. Null when unknown."},"postal":{"type":["string","null"]},"country":{"type":["string","null"],"pattern":"^[A-Z]{2}$","description":"Address country. It may differ from the company country."}}}},"industries":{"type":"array","items":{"type":"object","required":["type","code","name"],"properties":{"type":{"type":"string","minLength":1},"code":{"type":"string","minLength":1},"name":{"type":["string","null"]}}}},"parent":{"type":["string","null"],"pattern":"^co_[23456789abcdefghjkmnpqrstuvwxyz]{12}$","description":"Known parent company ID in this directory; omitted when unknown."},"description":{"type":["string","null"],"minLength":1,"maxLength":4000,"description":"Business summary based on company filings, or null. Omitted when unavailable."},"logo":{"type":["string","null"],"format":"uri","pattern":"^https?://","maxLength":4096,"description":"Recorded logo URL, or null. An asset reference does not grant permission to reuse it."},"social_profiles":{"type":"array","uniqueItems":true,"maxItems":30,"items":{"type":"object","additionalProperties":false,"required":["url","platform","handle"],"properties":{"platform":{"type":["string","null"],"minLength":1,"maxLength":64},"url":{"type":"string","format":"uri","pattern":"^https?://","maxLength":4096},"handle":{"type":["string","null"],"minLength":1,"maxLength":256}}},"description":"Recorded social profiles. Existing query and ID routes retain nullable platform and handle keys for installed clients."},"phone_numbers":{"type":"array","minItems":1,"maxItems":100,"uniqueItems":true,"description":"Selected public business phone records. Existing query and ID routes retain source-reported type, including null or business, for installed clients.","items":{"type":"object","additionalProperties":false,"required":["number","type","country","e164"],"properties":{"number":{"type":"string","minLength":3,"maxLength":64},"type":{"type":["string","null"],"maxLength":32},"country":{"type":["string","null"],"pattern":"^[A-Z]{2}$","description":"Country of the linked address, or null; never inferred from incorporation."},"e164":{"type":["string","null"],"pattern":"^\\+[1-9][0-9]{1,14}$","description":"Source-recorded E.164 number, or null; no reachability verification."}}}},"email_addresses":{"type":"array","minItems":1,"maxItems":100,"uniqueItems":true,"description":"Selected public business email records. Existing query and ID routes retain source-reported type, including null or business, for installed clients.","items":{"type":"object","additionalProperties":false,"required":["address","type"],"properties":{"address":{"type":"string","maxLength":320},"type":{"type":["string","null"],"maxLength":32}}}},"founded":{"description":"Reported business founding date with its recorded precision. Separate from legal incorporation; missing date components are not invented.","oneOf":[{"type":"null"},{"type":"object","required":["value","precision"],"properties":{"value":{"type":"string","pattern":"^(?!0000)[0-9]{4}$"},"precision":{"type":"string","const":"year"}}},{"type":"object","required":["value","precision"],"properties":{"value":{"type":"string","pattern":"^(?!0000)[0-9]{4}-(0[1-9]|1[0-2])$"},"precision":{"type":"string","const":"month"}}},{"type":"object","required":["value","precision"],"properties":{"value":{"type":"string","pattern":"^(?!0000)[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$","format":"date"},"precision":{"type":"string","const":"day"}}}]},"employees":{"type":["object","null"],"additionalProperties":false,"description":"Reported workforce count for the stated date, organization scope and basis. Reported counts may be rounded. Annual reports may describe an earlier workforce. Omitted when no supported count is selected.","required":["count","as_of","scope","approximate"],"properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"approximate":{"type":"boolean","deprecated":true,"description":"Source-reported flag retained on existing query and ID routes for installed clients."},"basis":{"type":"string","enum":["headcount","full_time","full_time_equivalent"],"description":"The source measurement: people, full-time employees, or full-time equivalents. Older responses without this field report headcount."},"as_of":{"type":"string","format":"date","pattern":"^(?!0000)[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Explicit measurement date, separate from source observation."},"scope":{"type":"string","enum":["legal_entity","consolidated_group"],"description":"Organization boundary stated by the source: one legal entity, or the parent and its consolidated subsidiaries."}}}}}},"next":{"type":["string","null"],"description":"Opaque continuation cursor. Pass it with the same selector, filters and limit. Null marks the last page."}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/company/domain/{domain}":{"get":{"operationId":"company_domain","tags":["Company"],"summary":"Get a company by domain","description":"Returns one flat company profile for a public website hostname. Paid plans automatically include available business details. No match returns 404; multiple company matches return 409 ambiguous_company instead of selecting one. Use API version 2.2.0. Full field reference: https://parseapi.com/docs/company","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"domain","in":"path","required":true,"description":"public website hostname","schema":{"type":"string","maxLength":254,"example":"apple.com"}},{"name":"deep","in":"query","required":false,"description":"Add available business details, identifiers, industry and dated employee counts on each profile. Included on paid plans in the same pooled request. Existing accounts retain their current Deep access. Omit or use false for Core.","schema":{"type":"boolean","default":false}},{"name":"pretty","in":"query","required":false,"description":"Format the JSON response for reading.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","required":["id","name","country","website","listings","address"],"properties":{"id":{"type":"string","pattern":"^co_[23456789abcdefghjkmnpqrstuvwxyz]{12}$","description":"Stable company ID."},"name":{"type":"string","minLength":1,"description":"Primary company name."},"country":{"type":["string","null"],"pattern":"^[A-Z]{2}$","description":"Recorded incorporation country in ISO 3166-1 alpha-2 form. It does not establish headquarters or operations and may differ from an address country."},"website":{"type":["string","null"],"format":"uri","description":"Recorded company website URL, or null when unknown. A domain alone does not establish a URL."},"listings":{"type":"array","description":"Exchange and symbol pairs. An empty array does not establish private ownership.","items":{"type":"object","required":["exchange","symbol"],"properties":{"exchange":{"type":"string","minLength":1,"description":"Recorded exchange name, not an ISO market identifier code (MIC)."},"symbol":{"type":"string","minLength":1}}}},"address":{"type":["object","null"],"required":["type","street","city","state","postal","country"],"properties":{"type":{"type":"string","enum":["registered","headquarters","business","mailing"]},"street":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"],"description":"State or region in ParseAPI's public form: uppercase, without a country prefix. Null when unknown."},"postal":{"type":["string","null"]},"country":{"type":["string","null"],"pattern":"^[A-Z]{2}$","description":"Address country. It may differ from the company country."}},"description":"One recorded address: headquarters first, then business, registered or mailing. The first recorded address of the selected type is returned, preserving its type. Null when no address is recorded."},"legal_name":{"type":["string","null"],"description":"Different legal entity name; omitted when it repeats the core name or is unknown."},"aliases":{"type":"array","items":{"type":"string","minLength":1}},"jurisdiction":{"type":["object","null"],"required":["country","state"],"description":"Recorded registration jurisdiction. Country and state are separate; an unknown state is null. The whole object is null when the jurisdiction is unknown.","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 registration country."},"state":{"type":["string","null"],"description":"Registration subdivision in ParseAPI's public state code form without the country prefix, or null for a country-only jurisdiction."}}},"status":{"type":["string","null"],"description":"Recorded legal entity status. Does not establish current business activity, website availability or listing status."},"domains":{"type":"array","description":"Other associated domains, excluding the hostname of the core website. If the core URL is unknown, all recorded hostnames appear here with null URLs.","items":{"type":"object","required":["domain","url"],"properties":{"domain":{"type":"string","minLength":1,"description":"Lowercase ASCII hostname with a conventional www. prefix removed."},"url":{"type":["string","null"],"format":"uri","description":"Recorded HTTP(S) URL for this exact normalized hostname, or null when unknown."}}}},"identifiers":{"type":"array","description":"Identifiers paired with their issuing authority. Values remain strings, including leading zeros.","items":{"type":"object","required":["type","authority","value"],"properties":{"type":{"type":"string","minLength":1},"authority":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}}}},"incorporated":{"type":["string","null"],"format":"date","description":"Legal entity incorporation date, distinct from brand founding."},"addresses":{"type":"array","description":"Other recorded addresses, excluding the selected core address and retaining their recorded order. Omitted when no additional address is recorded.","items":{"type":"object","required":["type","street","city","state","postal","country"],"properties":{"type":{"type":"string","enum":["registered","headquarters","business","mailing"]},"street":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"],"description":"State or region in ParseAPI's public form: uppercase, without a country prefix. Null when unknown."},"postal":{"type":["string","null"]},"country":{"type":["string","null"],"pattern":"^[A-Z]{2}$","description":"Address country. It may differ from the company country."}}}},"industries":{"type":"array","items":{"type":"object","required":["type","code","name"],"properties":{"type":{"type":"string","minLength":1},"code":{"type":"string","minLength":1},"name":{"type":["string","null"]}}}},"parent":{"type":["string","null"],"pattern":"^co_[23456789abcdefghjkmnpqrstuvwxyz]{12}$","description":"Known parent company ID in this directory; omitted when unknown."},"description":{"type":["string","null"],"minLength":1,"maxLength":4000,"description":"Business summary based on company filings, or null. Omitted when unavailable."},"logo":{"type":["string","null"],"format":"uri","pattern":"^https?://","maxLength":4096,"description":"Recorded logo URL, or null. An asset reference does not grant permission to reuse it."},"social_profiles":{"type":"array","uniqueItems":true,"maxItems":30,"items":{"type":"object","additionalProperties":false,"required":["url"],"properties":{"platform":{"type":["string","null"],"minLength":1,"maxLength":64},"url":{"type":"string","format":"uri","pattern":"^https?://","maxLength":4096},"handle":{"type":["string","null"],"minLength":1,"maxLength":256}}},"description":"Recorded social profiles. Unknown account metadata and unrecorded collections are omitted."},"phone_numbers":{"type":"array","minItems":1,"maxItems":100,"uniqueItems":true,"description":"Selected public business phone numbers. A specific source-reported purpose appears as type; unknown and generic business labels are omitted. Omitted when none are selected. No reachability or ownership verification.","items":{"type":"object","additionalProperties":false,"required":["number","country","e164"],"properties":{"number":{"type":"string","minLength":3,"maxLength":64},"type":{"type":["string","null"],"maxLength":32},"country":{"type":["string","null"],"pattern":"^[A-Z]{2}$","description":"Country of the linked address, or null; never inferred from incorporation."},"e164":{"type":["string","null"],"pattern":"^\\+[1-9][0-9]{1,14}$","description":"Source-recorded E.164 number, or null; no reachability verification."}}}},"email_addresses":{"type":"array","minItems":1,"maxItems":100,"uniqueItems":true,"description":"Selected public business email addresses. A specific source-reported purpose appears as type; unknown and generic business labels are omitted. Omitted when none are selected. No delivery or ownership verification.","items":{"type":"object","additionalProperties":false,"required":["address"],"properties":{"address":{"type":"string","maxLength":320},"type":{"type":["string","null"],"maxLength":32}}}},"founded":{"description":"Reported business founding date with its recorded precision. Separate from legal incorporation; missing date components are not invented.","oneOf":[{"type":"null"},{"type":"object","required":["value","precision"],"properties":{"value":{"type":"string","pattern":"^(?!0000)[0-9]{4}$"},"precision":{"type":"string","const":"year"}}},{"type":"object","required":["value","precision"],"properties":{"value":{"type":"string","pattern":"^(?!0000)[0-9]{4}-(0[1-9]|1[0-2])$"},"precision":{"type":"string","const":"month"}}},{"type":"object","required":["value","precision"],"properties":{"value":{"type":"string","pattern":"^(?!0000)[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$","format":"date"},"precision":{"type":"string","const":"day"}}}]},"employees":{"type":["object","null"],"additionalProperties":false,"description":"Reported workforce count for the stated date, organization scope and basis. Reported counts may be rounded. Annual reports may describe an earlier workforce. Omitted when no supported count is selected.","required":["count","as_of","scope"],"properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"approximate":{"type":"boolean","description":"Whether the reported count is approximate."},"basis":{"type":"string","enum":["headcount","full_time","full_time_equivalent"],"description":"The source measurement: people, full-time employees, or full-time equivalents. Older responses without this field report headcount."},"as_of":{"type":"string","format":"date","pattern":"^(?!0000)[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Explicit measurement date, separate from source observation."},"scope":{"type":"string","enum":["legal_entity","consolidated_group"],"description":"Organization boundary stated by the source: one legal entity, or the parent and its consolidated subsidiaries."}}}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"ambiguous_company","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/company/ticker/{ticker}":{"get":{"operationId":"company_ticker","tags":["Company"],"summary":"Get a company by ticker","description":"Returns one flat company profile for a trading symbol. Paid plans automatically include available business details. No match returns 404; multiple company matches return 409 ambiguous_company instead of selecting one. Use API version 2.2.0. Full field reference: https://parseapi.com/docs/company","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"ticker","in":"path","required":true,"description":"trading symbol","schema":{"type":"string","maxLength":64,"example":"AAPL"}},{"name":"exchange","in":"query","required":false,"description":"Recorded exchange name; use it when a ticker matches more than one company.","schema":{"type":"string","maxLength":128,"example":"Nasdaq"}},{"name":"deep","in":"query","required":false,"description":"Add available business details, identifiers, industry and dated employee counts on each profile. Included on paid plans in the same pooled request. Existing accounts retain their current Deep access. Omit or use false for Core.","schema":{"type":"boolean","default":false}},{"name":"pretty","in":"query","required":false,"description":"Format the JSON response for reading.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","required":["id","name","country","website","listings","address"],"properties":{"id":{"type":"string","pattern":"^co_[23456789abcdefghjkmnpqrstuvwxyz]{12}$","description":"Stable company ID."},"name":{"type":"string","minLength":1,"description":"Primary company name."},"country":{"type":["string","null"],"pattern":"^[A-Z]{2}$","description":"Recorded incorporation country in ISO 3166-1 alpha-2 form. It does not establish headquarters or operations and may differ from an address country."},"website":{"type":["string","null"],"format":"uri","description":"Recorded company website URL, or null when unknown. A domain alone does not establish a URL."},"listings":{"type":"array","description":"Exchange and symbol pairs. An empty array does not establish private ownership.","items":{"type":"object","required":["exchange","symbol"],"properties":{"exchange":{"type":"string","minLength":1,"description":"Recorded exchange name, not an ISO market identifier code (MIC)."},"symbol":{"type":"string","minLength":1}}}},"address":{"type":["object","null"],"required":["type","street","city","state","postal","country"],"properties":{"type":{"type":"string","enum":["registered","headquarters","business","mailing"]},"street":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"],"description":"State or region in ParseAPI's public form: uppercase, without a country prefix. Null when unknown."},"postal":{"type":["string","null"]},"country":{"type":["string","null"],"pattern":"^[A-Z]{2}$","description":"Address country. It may differ from the company country."}},"description":"One recorded address: headquarters first, then business, registered or mailing. The first recorded address of the selected type is returned, preserving its type. Null when no address is recorded."},"legal_name":{"type":["string","null"],"description":"Different legal entity name; omitted when it repeats the core name or is unknown."},"aliases":{"type":"array","items":{"type":"string","minLength":1}},"jurisdiction":{"type":["object","null"],"required":["country","state"],"description":"Recorded registration jurisdiction. Country and state are separate; an unknown state is null. The whole object is null when the jurisdiction is unknown.","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 registration country."},"state":{"type":["string","null"],"description":"Registration subdivision in ParseAPI's public state code form without the country prefix, or null for a country-only jurisdiction."}}},"status":{"type":["string","null"],"description":"Recorded legal entity status. Does not establish current business activity, website availability or listing status."},"domains":{"type":"array","description":"Other associated domains, excluding the hostname of the core website. If the core URL is unknown, all recorded hostnames appear here with null URLs.","items":{"type":"object","required":["domain","url"],"properties":{"domain":{"type":"string","minLength":1,"description":"Lowercase ASCII hostname with a conventional www. prefix removed."},"url":{"type":["string","null"],"format":"uri","description":"Recorded HTTP(S) URL for this exact normalized hostname, or null when unknown."}}}},"identifiers":{"type":"array","description":"Identifiers paired with their issuing authority. Values remain strings, including leading zeros.","items":{"type":"object","required":["type","authority","value"],"properties":{"type":{"type":"string","minLength":1},"authority":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}}}},"incorporated":{"type":["string","null"],"format":"date","description":"Legal entity incorporation date, distinct from brand founding."},"addresses":{"type":"array","description":"Other recorded addresses, excluding the selected core address and retaining their recorded order. Omitted when no additional address is recorded.","items":{"type":"object","required":["type","street","city","state","postal","country"],"properties":{"type":{"type":"string","enum":["registered","headquarters","business","mailing"]},"street":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"],"description":"State or region in ParseAPI's public form: uppercase, without a country prefix. Null when unknown."},"postal":{"type":["string","null"]},"country":{"type":["string","null"],"pattern":"^[A-Z]{2}$","description":"Address country. It may differ from the company country."}}}},"industries":{"type":"array","items":{"type":"object","required":["type","code","name"],"properties":{"type":{"type":"string","minLength":1},"code":{"type":"string","minLength":1},"name":{"type":["string","null"]}}}},"parent":{"type":["string","null"],"pattern":"^co_[23456789abcdefghjkmnpqrstuvwxyz]{12}$","description":"Known parent company ID in this directory; omitted when unknown."},"description":{"type":["string","null"],"minLength":1,"maxLength":4000,"description":"Business summary based on company filings, or null. Omitted when unavailable."},"logo":{"type":["string","null"],"format":"uri","pattern":"^https?://","maxLength":4096,"description":"Recorded logo URL, or null. An asset reference does not grant permission to reuse it."},"social_profiles":{"type":"array","uniqueItems":true,"maxItems":30,"items":{"type":"object","additionalProperties":false,"required":["url"],"properties":{"platform":{"type":["string","null"],"minLength":1,"maxLength":64},"url":{"type":"string","format":"uri","pattern":"^https?://","maxLength":4096},"handle":{"type":["string","null"],"minLength":1,"maxLength":256}}},"description":"Recorded social profiles. Unknown account metadata and unrecorded collections are omitted."},"phone_numbers":{"type":"array","minItems":1,"maxItems":100,"uniqueItems":true,"description":"Selected public business phone numbers. A specific source-reported purpose appears as type; unknown and generic business labels are omitted. Omitted when none are selected. No reachability or ownership verification.","items":{"type":"object","additionalProperties":false,"required":["number","country","e164"],"properties":{"number":{"type":"string","minLength":3,"maxLength":64},"type":{"type":["string","null"],"maxLength":32},"country":{"type":["string","null"],"pattern":"^[A-Z]{2}$","description":"Country of the linked address, or null; never inferred from incorporation."},"e164":{"type":["string","null"],"pattern":"^\\+[1-9][0-9]{1,14}$","description":"Source-recorded E.164 number, or null; no reachability verification."}}}},"email_addresses":{"type":"array","minItems":1,"maxItems":100,"uniqueItems":true,"description":"Selected public business email addresses. A specific source-reported purpose appears as type; unknown and generic business labels are omitted. Omitted when none are selected. No delivery or ownership verification.","items":{"type":"object","additionalProperties":false,"required":["address"],"properties":{"address":{"type":"string","maxLength":320},"type":{"type":["string","null"],"maxLength":32}}}},"founded":{"description":"Reported business founding date with its recorded precision. Separate from legal incorporation; missing date components are not invented.","oneOf":[{"type":"null"},{"type":"object","required":["value","precision"],"properties":{"value":{"type":"string","pattern":"^(?!0000)[0-9]{4}$"},"precision":{"type":"string","const":"year"}}},{"type":"object","required":["value","precision"],"properties":{"value":{"type":"string","pattern":"^(?!0000)[0-9]{4}-(0[1-9]|1[0-2])$"},"precision":{"type":"string","const":"month"}}},{"type":"object","required":["value","precision"],"properties":{"value":{"type":"string","pattern":"^(?!0000)[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$","format":"date"},"precision":{"type":"string","const":"day"}}}]},"employees":{"type":["object","null"],"additionalProperties":false,"description":"Reported workforce count for the stated date, organization scope and basis. Reported counts may be rounded. Annual reports may describe an earlier workforce. Omitted when no supported count is selected.","required":["count","as_of","scope"],"properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"approximate":{"type":"boolean","description":"Whether the reported count is approximate."},"basis":{"type":"string","enum":["headcount","full_time","full_time_equivalent"],"description":"The source measurement: people, full-time employees, or full-time equivalents. Older responses without this field report headcount."},"as_of":{"type":"string","format":"date","pattern":"^(?!0000)[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Explicit measurement date, separate from source observation."},"scope":{"type":"string","enum":["legal_entity","consolidated_group"],"description":"Organization boundary stated by the source: one legal entity, or the parent and its consolidated subsidiaries."}}}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"ambiguous_company","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/company/cik/{cik}":{"get":{"operationId":"company_cik","tags":["Company"],"summary":"Get a company by SEC CIK","description":"Returns one flat company profile for a SEC Central Index Key. Paid plans automatically include available business details. No match returns 404; multiple company matches return 409 ambiguous_company instead of selecting one. Use API version 2.2.0. Full field reference: https://parseapi.com/docs/company","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"cik","in":"path","required":true,"description":"SEC Central Index Key","schema":{"type":"string","pattern":"^[0-9]{1,10}$","example":"0000320193"}},{"name":"deep","in":"query","required":false,"description":"Add available business details, identifiers, industry and dated employee counts on each profile. Included on paid plans in the same pooled request. Existing accounts retain their current Deep access. Omit or use false for Core.","schema":{"type":"boolean","default":false}},{"name":"pretty","in":"query","required":false,"description":"Format the JSON response for reading.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","required":["id","name","country","website","listings","address"],"properties":{"id":{"type":"string","pattern":"^co_[23456789abcdefghjkmnpqrstuvwxyz]{12}$","description":"Stable company ID."},"name":{"type":"string","minLength":1,"description":"Primary company name."},"country":{"type":["string","null"],"pattern":"^[A-Z]{2}$","description":"Recorded incorporation country in ISO 3166-1 alpha-2 form. It does not establish headquarters or operations and may differ from an address country."},"website":{"type":["string","null"],"format":"uri","description":"Recorded company website URL, or null when unknown. A domain alone does not establish a URL."},"listings":{"type":"array","description":"Exchange and symbol pairs. An empty array does not establish private ownership.","items":{"type":"object","required":["exchange","symbol"],"properties":{"exchange":{"type":"string","minLength":1,"description":"Recorded exchange name, not an ISO market identifier code (MIC)."},"symbol":{"type":"string","minLength":1}}}},"address":{"type":["object","null"],"required":["type","street","city","state","postal","country"],"properties":{"type":{"type":"string","enum":["registered","headquarters","business","mailing"]},"street":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"],"description":"State or region in ParseAPI's public form: uppercase, without a country prefix. Null when unknown."},"postal":{"type":["string","null"]},"country":{"type":["string","null"],"pattern":"^[A-Z]{2}$","description":"Address country. It may differ from the company country."}},"description":"One recorded address: headquarters first, then business, registered or mailing. The first recorded address of the selected type is returned, preserving its type. Null when no address is recorded."},"legal_name":{"type":["string","null"],"description":"Different legal entity name; omitted when it repeats the core name or is unknown."},"aliases":{"type":"array","items":{"type":"string","minLength":1}},"jurisdiction":{"type":["object","null"],"required":["country","state"],"description":"Recorded registration jurisdiction. Country and state are separate; an unknown state is null. The whole object is null when the jurisdiction is unknown.","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 registration country."},"state":{"type":["string","null"],"description":"Registration subdivision in ParseAPI's public state code form without the country prefix, or null for a country-only jurisdiction."}}},"status":{"type":["string","null"],"description":"Recorded legal entity status. Does not establish current business activity, website availability or listing status."},"domains":{"type":"array","description":"Other associated domains, excluding the hostname of the core website. If the core URL is unknown, all recorded hostnames appear here with null URLs.","items":{"type":"object","required":["domain","url"],"properties":{"domain":{"type":"string","minLength":1,"description":"Lowercase ASCII hostname with a conventional www. prefix removed."},"url":{"type":["string","null"],"format":"uri","description":"Recorded HTTP(S) URL for this exact normalized hostname, or null when unknown."}}}},"identifiers":{"type":"array","description":"Identifiers paired with their issuing authority. Values remain strings, including leading zeros.","items":{"type":"object","required":["type","authority","value"],"properties":{"type":{"type":"string","minLength":1},"authority":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}}}},"incorporated":{"type":["string","null"],"format":"date","description":"Legal entity incorporation date, distinct from brand founding."},"addresses":{"type":"array","description":"Other recorded addresses, excluding the selected core address and retaining their recorded order. Omitted when no additional address is recorded.","items":{"type":"object","required":["type","street","city","state","postal","country"],"properties":{"type":{"type":"string","enum":["registered","headquarters","business","mailing"]},"street":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"],"description":"State or region in ParseAPI's public form: uppercase, without a country prefix. Null when unknown."},"postal":{"type":["string","null"]},"country":{"type":["string","null"],"pattern":"^[A-Z]{2}$","description":"Address country. It may differ from the company country."}}}},"industries":{"type":"array","items":{"type":"object","required":["type","code","name"],"properties":{"type":{"type":"string","minLength":1},"code":{"type":"string","minLength":1},"name":{"type":["string","null"]}}}},"parent":{"type":["string","null"],"pattern":"^co_[23456789abcdefghjkmnpqrstuvwxyz]{12}$","description":"Known parent company ID in this directory; omitted when unknown."},"description":{"type":["string","null"],"minLength":1,"maxLength":4000,"description":"Business summary based on company filings, or null. Omitted when unavailable."},"logo":{"type":["string","null"],"format":"uri","pattern":"^https?://","maxLength":4096,"description":"Recorded logo URL, or null. An asset reference does not grant permission to reuse it."},"social_profiles":{"type":"array","uniqueItems":true,"maxItems":30,"items":{"type":"object","additionalProperties":false,"required":["url"],"properties":{"platform":{"type":["string","null"],"minLength":1,"maxLength":64},"url":{"type":"string","format":"uri","pattern":"^https?://","maxLength":4096},"handle":{"type":["string","null"],"minLength":1,"maxLength":256}}},"description":"Recorded social profiles. Unknown account metadata and unrecorded collections are omitted."},"phone_numbers":{"type":"array","minItems":1,"maxItems":100,"uniqueItems":true,"description":"Selected public business phone numbers. A specific source-reported purpose appears as type; unknown and generic business labels are omitted. Omitted when none are selected. No reachability or ownership verification.","items":{"type":"object","additionalProperties":false,"required":["number","country","e164"],"properties":{"number":{"type":"string","minLength":3,"maxLength":64},"type":{"type":["string","null"],"maxLength":32},"country":{"type":["string","null"],"pattern":"^[A-Z]{2}$","description":"Country of the linked address, or null; never inferred from incorporation."},"e164":{"type":["string","null"],"pattern":"^\\+[1-9][0-9]{1,14}$","description":"Source-recorded E.164 number, or null; no reachability verification."}}}},"email_addresses":{"type":"array","minItems":1,"maxItems":100,"uniqueItems":true,"description":"Selected public business email addresses. A specific source-reported purpose appears as type; unknown and generic business labels are omitted. Omitted when none are selected. No delivery or ownership verification.","items":{"type":"object","additionalProperties":false,"required":["address"],"properties":{"address":{"type":"string","maxLength":320},"type":{"type":["string","null"],"maxLength":32}}}},"founded":{"description":"Reported business founding date with its recorded precision. Separate from legal incorporation; missing date components are not invented.","oneOf":[{"type":"null"},{"type":"object","required":["value","precision"],"properties":{"value":{"type":"string","pattern":"^(?!0000)[0-9]{4}$"},"precision":{"type":"string","const":"year"}}},{"type":"object","required":["value","precision"],"properties":{"value":{"type":"string","pattern":"^(?!0000)[0-9]{4}-(0[1-9]|1[0-2])$"},"precision":{"type":"string","const":"month"}}},{"type":"object","required":["value","precision"],"properties":{"value":{"type":"string","pattern":"^(?!0000)[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$","format":"date"},"precision":{"type":"string","const":"day"}}}]},"employees":{"type":["object","null"],"additionalProperties":false,"description":"Reported workforce count for the stated date, organization scope and basis. Reported counts may be rounded. Annual reports may describe an earlier workforce. Omitted when no supported count is selected.","required":["count","as_of","scope"],"properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"approximate":{"type":"boolean","description":"Whether the reported count is approximate."},"basis":{"type":"string","enum":["headcount","full_time","full_time_equivalent"],"description":"The source measurement: people, full-time employees, or full-time equivalents. Older responses without this field report headcount."},"as_of":{"type":"string","format":"date","pattern":"^(?!0000)[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Explicit measurement date, separate from source observation."},"scope":{"type":"string","enum":["legal_entity","consolidated_group"],"description":"Organization boundary stated by the source: one legal entity, or the parent and its consolidated subsidiaries."}}}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"ambiguous_company","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/company/id/{id}":{"get":{"operationId":"company_profile","tags":["Company"],"summary":"Get a company by stable ID","description":"Returns company identity, one recorded website URL, exchange and symbol pairs, and one recorded address. Paid plans include legal entity status, legal details, other websites and additional addresses automatically. Unknown scalar values are null; an unknown company ID returns 404. Use API version 2.2.0. Full field reference: https://parseapi.com/docs/company","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"id","in":"path","required":true,"description":"Stable company ID returned by search.","schema":{"type":"string","pattern":"^co_[23456789abcdefghjkmnpqrstuvwxyz]{12}$","example":"co_g9puf74dwzwn"}},{"name":"deep","in":"query","required":false,"description":"Add available business details, identifiers, industry and dated employee counts on each profile. Included on paid plans in the same pooled request. Existing accounts retain their current Deep access. Omit or use false for Core.","schema":{"type":"boolean","default":false}},{"name":"pretty","in":"query","required":false,"description":"Format the JSON response for reading.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","required":["id","name","country","website","listings","address"],"properties":{"id":{"type":"string","pattern":"^co_[23456789abcdefghjkmnpqrstuvwxyz]{12}$","description":"Stable company ID."},"name":{"type":"string","minLength":1,"description":"Primary company name."},"country":{"type":["string","null"],"pattern":"^[A-Z]{2}$","description":"Recorded incorporation country in ISO 3166-1 alpha-2 form. It does not establish headquarters or operations and may differ from an address country."},"website":{"type":["string","null"],"format":"uri","description":"Recorded company website URL, or null when unknown. A domain alone does not establish a URL."},"listings":{"type":"array","description":"Exchange and symbol pairs. An empty array does not establish private ownership.","items":{"type":"object","required":["exchange","symbol"],"properties":{"exchange":{"type":"string","minLength":1,"description":"Recorded exchange name, not an ISO market identifier code (MIC)."},"symbol":{"type":"string","minLength":1}}}},"address":{"type":["object","null"],"required":["type","street","city","state","postal","country"],"properties":{"type":{"type":"string","enum":["registered","headquarters","business","mailing"]},"street":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"],"description":"State or region in ParseAPI's public form: uppercase, without a country prefix. Null when unknown."},"postal":{"type":["string","null"]},"country":{"type":["string","null"],"pattern":"^[A-Z]{2}$","description":"Address country. It may differ from the company country."}},"description":"One recorded address: headquarters first, then business, registered or mailing. The first recorded address of the selected type is returned, preserving its type. Null when no address is recorded."},"legal_name":{"type":["string","null"],"description":"Different legal entity name; omitted when it repeats the core name or is unknown."},"aliases":{"type":"array","items":{"type":"string","minLength":1}},"jurisdiction":{"type":["object","null"],"required":["country","state"],"description":"Recorded registration jurisdiction. Country and state are separate; an unknown state is null. The whole object is null when the jurisdiction is unknown.","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 registration country."},"state":{"type":["string","null"],"description":"Registration subdivision in ParseAPI's public state code form without the country prefix, or null for a country-only jurisdiction."}}},"status":{"type":["string","null"],"description":"Recorded legal entity status. Does not establish current business activity, website availability or listing status."},"domains":{"type":"array","description":"Other associated domains, excluding the hostname of the core website. If the core URL is unknown, all recorded hostnames appear here with null URLs.","items":{"type":"object","required":["domain","url"],"properties":{"domain":{"type":"string","minLength":1,"description":"Lowercase ASCII hostname with a conventional www. prefix removed."},"url":{"type":["string","null"],"format":"uri","description":"Recorded HTTP(S) URL for this exact normalized hostname, or null when unknown."}}}},"identifiers":{"type":"array","description":"Identifiers paired with their issuing authority. Values remain strings, including leading zeros.","items":{"type":"object","required":["type","authority","value"],"properties":{"type":{"type":"string","minLength":1},"authority":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}}}},"incorporated":{"type":["string","null"],"format":"date","description":"Legal entity incorporation date, distinct from brand founding."},"addresses":{"type":"array","description":"Other recorded addresses, excluding the selected core address and retaining their recorded order. Omitted when no additional address is recorded.","items":{"type":"object","required":["type","street","city","state","postal","country"],"properties":{"type":{"type":"string","enum":["registered","headquarters","business","mailing"]},"street":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"],"description":"State or region in ParseAPI's public form: uppercase, without a country prefix. Null when unknown."},"postal":{"type":["string","null"]},"country":{"type":["string","null"],"pattern":"^[A-Z]{2}$","description":"Address country. It may differ from the company country."}}}},"industries":{"type":"array","items":{"type":"object","required":["type","code","name"],"properties":{"type":{"type":"string","minLength":1},"code":{"type":"string","minLength":1},"name":{"type":["string","null"]}}}},"parent":{"type":["string","null"],"pattern":"^co_[23456789abcdefghjkmnpqrstuvwxyz]{12}$","description":"Known parent company ID in this directory; omitted when unknown."},"description":{"type":["string","null"],"minLength":1,"maxLength":4000,"description":"Business summary based on company filings, or null. Omitted when unavailable."},"logo":{"type":["string","null"],"format":"uri","pattern":"^https?://","maxLength":4096,"description":"Recorded logo URL, or null. An asset reference does not grant permission to reuse it."},"social_profiles":{"type":"array","uniqueItems":true,"maxItems":30,"items":{"type":"object","additionalProperties":false,"required":["url","platform","handle"],"properties":{"platform":{"type":["string","null"],"minLength":1,"maxLength":64},"url":{"type":"string","format":"uri","pattern":"^https?://","maxLength":4096},"handle":{"type":["string","null"],"minLength":1,"maxLength":256}}},"description":"Recorded social profiles. Existing query and ID routes retain nullable platform and handle keys for installed clients."},"phone_numbers":{"type":"array","minItems":1,"maxItems":100,"uniqueItems":true,"description":"Selected public business phone records. Existing query and ID routes retain source-reported type, including null or business, for installed clients.","items":{"type":"object","additionalProperties":false,"required":["number","type","country","e164"],"properties":{"number":{"type":"string","minLength":3,"maxLength":64},"type":{"type":["string","null"],"maxLength":32},"country":{"type":["string","null"],"pattern":"^[A-Z]{2}$","description":"Country of the linked address, or null; never inferred from incorporation."},"e164":{"type":["string","null"],"pattern":"^\\+[1-9][0-9]{1,14}$","description":"Source-recorded E.164 number, or null; no reachability verification."}}}},"email_addresses":{"type":"array","minItems":1,"maxItems":100,"uniqueItems":true,"description":"Selected public business email records. Existing query and ID routes retain source-reported type, including null or business, for installed clients.","items":{"type":"object","additionalProperties":false,"required":["address","type"],"properties":{"address":{"type":"string","maxLength":320},"type":{"type":["string","null"],"maxLength":32}}}},"founded":{"description":"Reported business founding date with its recorded precision. Separate from legal incorporation; missing date components are not invented.","oneOf":[{"type":"null"},{"type":"object","required":["value","precision"],"properties":{"value":{"type":"string","pattern":"^(?!0000)[0-9]{4}$"},"precision":{"type":"string","const":"year"}}},{"type":"object","required":["value","precision"],"properties":{"value":{"type":"string","pattern":"^(?!0000)[0-9]{4}-(0[1-9]|1[0-2])$"},"precision":{"type":"string","const":"month"}}},{"type":"object","required":["value","precision"],"properties":{"value":{"type":"string","pattern":"^(?!0000)[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$","format":"date"},"precision":{"type":"string","const":"day"}}}]},"employees":{"type":["object","null"],"additionalProperties":false,"description":"Reported workforce count for the stated date, organization scope and basis. Reported counts may be rounded. Annual reports may describe an earlier workforce. Omitted when no supported count is selected.","required":["count","as_of","scope","approximate"],"properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"approximate":{"type":"boolean","deprecated":true,"description":"Source-reported flag retained on existing query and ID routes for installed clients."},"basis":{"type":"string","enum":["headcount","full_time","full_time_equivalent"],"description":"The source measurement: people, full-time employees, or full-time equivalents. Older responses without this field report headcount."},"as_of":{"type":"string","format":"date","pattern":"^(?!0000)[0-9]{4}-[0-9]{2}-[0-9]{2}$","description":"Explicit measurement date, separate from source observation."},"scope":{"type":"string","enum":["legal_entity","consolidated_group"],"description":"Organization boundary stated by the source: one legal entity, or the parent and its consolidated subsidiaries."}}}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/domain/{domain}":{"get":{"operationId":"domain","tags":["Domain"],"summary":"Check if a domain is available to register","description":"Returns domain and available: true when unregistered, false when registered, or null when the registration check is unavailable. Paid deep adds registration with created, updated, expires, registrar, status, and dnssec. Registration details are omitted when unavailable. Results are cached. Use /dns/{domain} for DNS records and /mx/{domain} for mail routing. Full field reference: https://parseapi.com/docs/domain","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"domain","in":"path","required":true,"description":"Domain name","schema":{"type":"string","example":"example.com"}},{"name":"deep","in":"query","required":false,"description":"Registration dates, registrar, status and DNSSEC. Included automatically on paid plans in API 2.2.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string"},"available":{"type":["boolean","null"]},"registration":{"type":"object","properties":{"created":{"type":["string","null"]},"updated":{"type":["string","null"]},"expires":{"type":["string","null"]},"registrar":{"type":["string","null"]},"status":{"type":["array","null"],"items":{"type":"string"}},"dnssec":{"type":["boolean","null"]}},"required":[],"additionalProperties":true}},"required":["domain","available"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/dns/{domain}":{"get":{"operationId":"dns","tags":["DNS"],"summary":"Look up DNS records at a name","description":"One pooled request on every plan, including Free. Omit type to query A, AAAA, CNAME, MX, NS, TXT, SOA, CAA, SRV, and PTR individually at the supplied name. This is a resolver-view answer for that name, not a zone listing or a global propagation check. Typed answers can include CNAME-chain records. ttl is the remaining lifetime in seconds, including time spent cached. No records for an existing name returns 200 with records: []. NXDOMAIN at the queried name returns 404. A published CNAME chain is retained when its target does not exist. A failed lookup returns 503, never a partial or empty success. Full field reference: https://parseapi.com/docs/dns","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"domain","in":"path","required":true,"description":"Complete DNS name. Supports internationalized names, subdomains, _dmarc and _service._tcp labels, and reverse names under in-addr.arpa or ip6.arpa. A trailing dot is accepted","schema":{"type":"string","example":"example.com"}},{"name":"type","in":"query","required":false,"description":"One record type, case-insensitive: A, AAAA, CNAME, MX, NS, TXT, SOA, CAA, SRV, or PTR. Omit to query all ten. Unsupported or repeated types return 400","schema":{"type":"string","example":"TXT"}},{"name":"deep","in":"query","required":false,"description":"No additional fields or charge","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","description":"Lowercase ASCII DNS name without a trailing dot. Internationalized names use Punycode"},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Record owner name"},"type":{"type":"string","enum":["A","AAAA","CNAME","MX","NS","TXT","SOA","CAA","SRV","PTR"]},"ttl":{"type":"integer","minimum":0,"description":"Remaining cache lifetime in seconds when the response is generated"},"value":{"type":"string","description":"DNS answer text preserved as returned, including TXT quotes, escapes, and chunk boundaries when present. MX is priority followed by host. Names within values can retain trailing dots"}},"required":["name","type","ttl","value"],"additionalProperties":true}}},"required":["domain","records"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/mx/{domain}":{"get":{"operationId":"mx","tags":["MX"],"summary":"MX records for a domain","description":"Ordered MX records with priority and host. A priority-0 host of . is an explicit null MX: the domain accepts no mail. An empty array means no MX records, which permits SMTP A/AAAA fallback. Full field reference: https://parseapi.com/docs/mx","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"domain","in":"path","required":true,"description":"Domain name","schema":{"type":"string","example":"example.com"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string"},"mx":{"type":"array","items":{"type":"object","properties":{"priority":{"type":"number"},"host":{"type":"string"}},"required":["priority","host"],"additionalProperties":true}}},"required":["domain","mx"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/useragent":{"get":{"operationId":"useragent","tags":["Useragent"],"summary":"Parse the User-Agent (and Client Hints when present)","description":"Bare (no ua parameter) it parses the User-Agent that made the request, no key needed. With ?ua= it is a keyed lookup. Full field reference: https://parseapi.com/docs/useragent","security":[{},{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"User-Agent","in":"header","required":false,"description":"User-Agent string to parse (defaults to the request UA)","schema":{"type":"string"}},{"name":"ua","in":"query","required":false,"description":"User-Agent string to parse instead of the request UA (requires a key)","schema":{"type":"string"}},{"name":"deep","in":"query","required":false,"description":"Device, operating system, browser, engine and bot detail. Included automatically on paid plans in API 2.2.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"useragent":{"type":"string"},"device":{"type":"object","required":["type"],"properties":{"type":{"type":["string","null"]},"brand":{"type":["string","null"]},"model":{"type":["string","null"]},"cpu":{"type":["string","null"]},"touchscreen":{"type":["boolean","null"]}},"additionalProperties":true},"os":{"type":"object","required":["name"],"properties":{"name":{"type":["string","null"]},"version":{"type":["string","null"]},"platform":{"type":["string","null"]}},"additionalProperties":true},"browser":{"type":"object","required":["name"],"properties":{"name":{"type":["string","null"]},"version":{"type":["string","null"]},"type":{"type":["string","null"]},"brands":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"string"},"version":{"type":"string"}},"required":["brand","version"],"additionalProperties":true}}},"additionalProperties":true},"bot":{"type":"boolean"},"mobile":{"type":"boolean"},"engine":{"type":"object","properties":{"name":{"type":["string","null"]},"version":{"type":["string","null"]}},"required":["name","version"],"additionalProperties":true},"headless":{"type":"boolean"},"bot_details":{"type":"object","properties":{"name":{"type":["string","null"]},"category":{"type":["string","null"]},"url":{"type":["string","null"]},"vendor":{"type":["string","null"]}},"required":["name","category","url","vendor"],"additionalProperties":true},"ai":{"type":"boolean"}},"required":["useragent","device","os","browser","bot","mobile"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/currency/{code}":{"get":{"operationId":"currency","tags":["Currency"],"summary":"Look up a currency by ISO code","description":"Currency names and symbols, plus daily exchange rates. Full field reference: https://parseapi.com/docs/currency","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"code","in":"path","required":true,"description":"ISO 4217 currency code","schema":{"type":"string","example":"USD"}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"currency":{"type":["string","null"]},"iso_numeric":{"type":["integer","null"]},"name":{"type":["string","null"]},"name_plural":{"type":["string","null"]},"symbol":{"type":["string","null"]},"symbol_native":{"type":["string","null"]},"digits":{"type":["integer","null"]},"countries":{"type":["array","null"],"items":{"type":"string"}}},"required":["currency","iso_numeric","name","name_plural","symbol","symbol_native","digits","countries"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/currency/{base}/{quote}":{"get":{"operationId":"currency_rate","tags":["Currency"],"summary":"Daily official exchange rate for a currency pair","description":"Daily official reference rate from central banks. Add date for a past business day. Add amount to convert. A weekend or holiday resolves to the last published day on or before it. Full field reference: https://parseapi.com/docs/currency","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"base","in":"path","required":true,"description":"Base currency code (ISO 4217)","schema":{"type":"string","example":"USD"}},{"name":"quote","in":"path","required":true,"description":"Quote currency code (ISO 4217)","schema":{"type":"string","example":"EUR"}},{"name":"date","in":"query","required":false,"description":"YYYY-MM-DD. Official rate for that business day. A weekend or holiday resolves to the last published day on or before it. Older than held history is a 404","schema":{"type":"string","example":"2026-08-28"}},{"name":"amount","in":"query","required":false,"description":"Appends amount and converted, rounded to the quote currency minor-unit digits","schema":{"type":"number","example":100}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"base":{"type":"string"},"quote":{"type":"string"},"rate":{"type":"number"},"date":{"type":["string","null"]},"amount":{"type":"number"},"converted":{"type":["number","null"]}},"required":["base","quote","rate","date"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/language/detect":{"post":{"operationId":"language_detect","tags":["Language"],"summary":"Detect the language of text","description":"Send one text string. Returns language, English name, native name, script and text direction from the language reference. The language fields are null with HTTP 200 when unidentified. Supports 32 languages. ISO-3 and associated country codes are included in Core on every plan. Send one language per request. One pooled request on every plan. Select X-API-Version: 2.2.0. Busy or temporarily unavailable reference metadata returns 503 with Retry-After. Full field reference: https://parseapi.com/docs/language","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"deep","in":"query","required":false,"description":"Core includes the ISO-3 code and country links on every plan. No additional profile fields are needed.","schema":{"type":"boolean"}},{"name":"pretty","in":"query","required":false,"description":"Indent the JSON response.","schema":{"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["text"],"additionalProperties":false,"properties":{"text":{"type":"string","maxLength":20000,"description":"At most 20,000 UTF-16 code units before normalization, and 10,000 code points after normalization. Send one language per request."}}},"example":{"text":"Please send the updated invoice to our office before Friday afternoon."}}}},"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"ar"},"name":{"type":"string","const":"Arabic"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"ca"},"name":{"type":"string","const":"Catalan"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"zh"},"name":{"type":"string","const":"Chinese"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"hr"},"name":{"type":"string","const":"Croatian"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"cs"},"name":{"type":"string","const":"Czech"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"da"},"name":{"type":"string","const":"Danish"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"nl"},"name":{"type":"string","const":"Dutch"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"en"},"name":{"type":"string","const":"English"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"fi"},"name":{"type":"string","const":"Finnish"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"fr"},"name":{"type":"string","const":"French"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"de"},"name":{"type":"string","const":"German"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"el"},"name":{"type":"string","const":"Greek"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"he"},"name":{"type":"string","const":"Hebrew"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"hi"},"name":{"type":"string","const":"Hindi"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"hu"},"name":{"type":"string","const":"Hungarian"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"id"},"name":{"type":"string","const":"Indonesian"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"it"},"name":{"type":"string","const":"Italian"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"ja"},"name":{"type":"string","const":"Japanese"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"ko"},"name":{"type":"string","const":"Korean"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"ms"},"name":{"type":"string","const":"Malay"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"nb"},"name":{"type":"string","const":"Norwegian Bokmål"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"pl"},"name":{"type":"string","const":"Polish"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"pt"},"name":{"type":"string","const":"Portuguese"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"ro"},"name":{"type":"string","const":"Romanian"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"ru"},"name":{"type":"string","const":"Russian"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"sk"},"name":{"type":"string","const":"Slovak"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"es"},"name":{"type":"string","const":"Spanish"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"sv"},"name":{"type":"string","const":"Swedish"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"th"},"name":{"type":"string","const":"Thai"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"tr"},"name":{"type":"string","const":"Turkish"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"uk"},"name":{"type":"string","const":"Ukrainian"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"string","const":"vi"},"name":{"type":"string","const":"Vietnamese"},"name_local":{"type":["string","null"]},"script":{"type":["string","null"]},"direction":{"enum":["ltr","rtl",null]},"iso_alpha3":{"type":["string","null"],"pattern":"^[a-z]{3}$"},"countries":{"type":["array","null"],"items":{"type":"string","pattern":"^[A-Z]{2}$"}}}},{"type":"object","required":["language","name","name_local","script","direction"],"additionalProperties":false,"properties":{"language":{"type":"null"},"name":{"type":"null"},"name_local":{"type":"null"},"script":{"type":"null"},"direction":{"type":"null"},"iso_alpha3":{"type":"null"},"countries":{"type":"null"}}}]}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/language/{code}":{"get":{"operationId":"language","tags":["Language"],"summary":"Look up a language by ISO 639 code","description":"Accepts the BCP 47 shortest code (en, gsw) or ISO 639-3 (eng). Both resolve to the same record. Full field reference: https://parseapi.com/docs/language","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"code","in":"path","required":true,"description":"ISO 639 language code, 2 or 3 letters","schema":{"type":"string","example":"ja"}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"language":{"type":"string"},"iso_alpha3":{"type":["string","null"]},"countries":{"type":["array","null"],"items":{"type":"string"}},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"script":{"type":["string","null"]},"direction":{"anyOf":[{"const":"ltr","type":"string"},{"const":"rtl","type":"string"},{"type":"string"}]}},"required":["language","name","name_local","script","direction"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/name/{name}":{"get":{"operationId":"name","tags":["Name"],"summary":"Parse a person's name","description":"Splits into first, middle, last, prefix, and suffix, fixes all-caps and all-lowercase input, resolves Last, First order, and flags junk with valid false. Matches an exact cleaned compound before its first-name key. Optional country selects explicit context for gender; ambiguity stays null. Paid deep adds short, directory and initials using CLDR formatting rules. name_locale selects formatting only and defaults to en; it does not change parsing, spelling or gender evidence. Full field reference: https://parseapi.com/docs/name","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"name","in":"path","required":true,"description":"The name as you have it, URL-encoded","schema":{"type":"string","minLength":1,"maxLength":120,"example":"MARY SMITH"}},{"name":"country","in":"query","required":false,"description":"Optional ISO2 country context for the name evidence. Does not infer nationality.","schema":{"type":"string","pattern":"^[a-zA-Z]{2}$","example":"IT"}},{"name":"name_locale","in":"query","required":false,"description":"Optional BCP 47 name-formatting locale, such as en or ja. Defaults to en. Selects supported CLDR 47 rules, using locale parents where available. Unsupported locales return 400. Changes formatting only, not parsing or gender. Never inferred from country, lang or browser language.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"en"}},{"name":"deep","in":"query","required":false,"description":"Gender evidence, short and directory formats, and initials. Included automatically on paid plans in API 2.2.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"valid":{"type":"boolean"},"prefix":{"type":["string","null"]},"first":{"type":["string","null"]},"middle":{"type":["string","null"]},"last":{"type":["string","null"]},"suffix":{"type":["string","null"]},"gender":{"anyOf":[{"const":"male","type":"string"},{"const":"female","type":"string"},{"type":"null"}],"type":["string","null"],"enum":["male","female",null],"description":"Optional name evidence; null when ambiguous or unsupported in the selected context."},"short":{"type":["string","null"],"description":"Compact name using name_locale formatting rules. Null for an invalid name.","example":"R.J. Smith"},"directory":{"type":["string","null"],"description":"Directory listing using name_locale formatting rules. Null for an invalid name.","example":"Smith, Robert James"},"initials":{"type":["string","null"],"description":"Name initials using name_locale formatting rules. Null for an invalid name.","example":"RJS"}},"required":["name","valid","prefix","first","middle","last","suffix"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/time/zones":{"get":{"operationId":"time_zones","tags":["Time"],"summary":"Find supported IANA timezone identifiers","description":"Discover identifiers and explicit abbreviation candidates. Filter by country, IANA area, offset, DST or yearly observance; sort by identifier or offset. details=true returns rich zones rows in place of the compact timezones identifier list. No match returns an empty collection. All time-dependent filters use one instant. One pooled request on every plan. Full field reference: https://parseapi.com/docs/time","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"q","in":"query","required":false,"description":"Search identifier tokens, ignoring case and treating spaces and underscores alike.","schema":{"type":"string","maxLength":64,"example":"new york"}},{"name":"country","in":"query","required":false,"description":"Filter by associated ISO alpha-2 country. IANA shared-rule associations since 1970 can connect one zone to several countries.","schema":{"type":"string","pattern":"^[A-Za-z]{2}$"}},{"name":"area","in":"query","required":false,"description":"IANA area prefix, such as America, Europe or Pacific.","schema":{"type":"string","enum":["Africa","America","Antarctica","Arctic","Asia","Atlantic","Australia","Europe","Indian","Pacific","Etc"]}},{"name":"offset","in":"query","required":false,"description":"Actual offset at the selected instant, ±HH:MM[:SS]. URL-encode a leading plus as %2B.","schema":{"type":"string","example":"-05:00"}},{"name":"abbreviation","in":"query","required":false,"description":"Exact case-insensitive abbreviation at the selected instant. Returns all matching identifiers; CST never silently chooses one zone.","schema":{"type":"string","maxLength":16,"example":"CST"}},{"name":"dst","in":"query","required":false,"description":"Filter the DST rule flag at the selected instant. Both true and false are meaningful.","schema":{"type":"boolean"}},{"name":"observes_dst","in":"query","required":false,"description":"Filter whether the DST rule flag occurs in the selected UTC calendar year.","schema":{"type":"boolean"}},{"name":"sort","in":"query","required":false,"description":"Identifier order, or numeric UTC offset then identifier.","schema":{"type":"string","enum":["timezone","offset"],"default":"timezone"}},{"name":"at","in":"query","required":false,"description":"ISO date/timestamp used for all time-dependent filters. Offsetless input means UTC; defaults to one captured now.","schema":{"type":"string","maxLength":40}},{"name":"details","in":"query","required":false,"description":"Return detailed zones rows in place of the compact timezones list.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","oneOf":[{"required":["timezones"],"not":{"required":["zones"]}},{"required":["at","zones"],"not":{"required":["timezones"]}}],"properties":{"timezones":{"type":"array","items":{"type":"string"},"description":"Matching IANA identifiers. Returned without details; empty when no matches."},"at":{"type":"string","description":"Captured UTC instant for time-dependent filters and detailed rows."},"zones":{"type":"array","description":"Returned with details=true, replacing the string identifier list.","items":{"type":"object","required":["timezone","countries","area","abbreviation","offset","offset_seconds","dst","observes_dst"],"properties":{"timezone":{"type":"string"},"countries":{"type":"array","items":{"type":"string"}},"area":{"type":["string","null"]},"abbreviation":{"type":["string","null"]},"offset":{"type":"string"},"offset_seconds":{"type":"integer"},"dst":{"type":"boolean"},"observes_dst":{"type":"boolean","description":"The DST rule flag occurs at some instant in the UTC calendar year containing at."}}}}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/time":{"get":{"operationId":"time_lookup","tags":["Time"],"summary":"Get UTC time, or local time for a place","description":"Returns current UTC time by default. Supply lat and lon together, or one explicit city, country, IP, IATA, ICAO, port UN/LOCODE or US street-address selector. Place inputs add location status and candidates; ambiguous or missing locations retain null clocks. Coordinates over open ocean use a nautical Etc/GMT zone. Deep includes seasonal boundaries, standard offsets and local-wall resolution. Supports at with to or targets for conversion. One pooled request on every plan. Full field reference: https://parseapi.com/docs/time","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"lat","in":"query","required":false,"description":"Latitude. Requires lon; omit both for UTC","schema":{"type":"number","minimum":-90,"maximum":90,"example":40.7128}},{"name":"lon","in":"query","required":false,"description":"Longitude. Requires lat; omit both for UTC","schema":{"type":"number","minimum":-180,"maximum":180,"example":-74.006}},{"name":"ip","in":"query","required":false,"description":"Explicit IPv4 or IPv6 network location. Private, unknown or ambiguous locations remain unresolved. Mutually exclusive with every primary selector and coordinates.","schema":{"type":"string","maxLength":45}},{"name":"city","in":"query","required":false,"description":"Exact city name or stable city ID. Optional country/state narrows matches. Multiple places return choices; no population-ranked selection.","schema":{"type":"string","maxLength":200,"example":"Paris"}},{"name":"country","in":"query","required":false,"description":"ISO alpha-2 country selector, or context for city/address. A country with multiple timezones returns choices.","schema":{"type":"string","pattern":"^[A-Za-z]{2}$","example":"FR"}},{"name":"state","in":"query","required":false,"description":"Subdivision code for city/address, with country required. Bare code or country-prefixed code.","schema":{"type":"string","pattern":"^(?:[A-Za-z]{2}-)?[A-Za-z0-9]{1,3}$"}},{"name":"iata","in":"query","required":false,"description":"Three-letter airport code. Multiple records remain choices. Mutually exclusive with other primary inputs.","schema":{"type":"string","pattern":"^[A-Za-z]{3}$","example":"JFK"}},{"name":"icao","in":"query","required":false,"description":"Four-letter ICAO airport code, matched to recorded airport coordinates.","schema":{"type":"string","pattern":"^[A-Za-z]{4}$","example":"RJTT"}},{"name":"unlocode","in":"query","required":false,"description":"UN/LOCODE for a covered port with recorded coordinates. Two country letters plus three location characters; optional separating space.","schema":{"type":"string","pattern":"^[A-Za-z]{2} ?[A-Za-z2-9]{3}$","example":"NLRTM"}},{"name":"address","in":"query","required":false,"description":"Street address with country=US. Exact recorded point matches only; missing or ambiguous points remain unresolved. Include number and postal code. This lookup does not verify delivery or occupancy.","schema":{"type":"string","maxLength":200}},{"name":"at","in":"query","required":false,"description":"ISO date and time with up to three fractional-second digits; defaults to now. Unix numbers are not accepted as input. An explicit Z or UTC offset identifies an instant. With to= or targets=, no offset means source-zone wall time; without either, no offset means UTC. By default, repeated wall times select the earlier occurrence and skipped times advance by the offset gap. Use disambiguation to choose another policy. Invalid calendar dates return 400.","schema":{"type":"string","maxLength":40,"example":"2026-08-29T19:00:00Z"}},{"name":"to","in":"query","required":false,"description":"Destination IANA timezone. Appends to with local at, unix, timezone, abbreviation, offset, and dst for the same instant. deep=true adds name, offset_minutes, and offset_seconds at to.name, to.offset_minutes and to.offset_seconds.","schema":{"type":"string","maxLength":64,"example":"Asia/Tokyo"}},{"name":"disambiguation","in":"query","required":false,"description":"For offsetless at with to or targets: compatible selects the earlier repeated time and advances skipped times by the clock gap; earlier or later chooses the earlier or later instant; reject returns HTTP 400 ambiguous_time for a repeat or nonexistent_time for a gap. Branch on code, then ask for a choice before retrying. Valid values do not alter an explicit-offset instant, now, or the UTC interpretation without a destination. Invalid policies return 400 invalid_request.","schema":{"type":"string","enum":["compatible","earlier","later","reject"],"default":"compatible"}},{"name":"targets","in":"query","required":false,"description":"Comma-separated list of 1–10 IANA destination identifiers, instead of to. Appends an ordered targets array with one compact clock per requested zone. Duplicates stay in place, all unix values match, and any unknown zone rejects the whole request. One pooled request for the entire conversion. deep=true adds numeric offsets and a name to each target.","schema":{"type":"string","minLength":1,"maxLength":649,"example":"Europe/London,Asia/Tokyo"}},{"name":"deep","in":"query","required":false,"description":"Friendly zone name, numeric offsets, clock changes, seasonal boundaries and local-time resolution. Included automatically on paid plans in API 2.2. Existing accounts retain their current profile access.","schema":{"type":"boolean","enum":[true]}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","required":["at","unix","timezone","abbreviation","offset","dst"],"properties":{"at":{"type":["string","null"],"description":"Local ISO datetime with its UTC offset. Nonzero milliseconds are preserved. Historical subminute offsets use ±HH:MM:SS; consume unix if your date parser only supports whole-minute offsets."},"unix":{"type":["integer","null"],"description":"Unix seconds for this instant, rounded down."},"timezone":{"type":["string","null"],"description":"IANA timezone identifier; UTC for the bare route."},"abbreviation":{"type":["string","null"]},"offset":{"type":["string","null"],"pattern":"^[+-]\\d{2}:\\d{2}(?::\\d{2})?$"},"dst":{"type":["boolean","null"],"description":"Timezone-rule daylight-saving indicator, including negative seasonal adjustments."},"latitude":{"type":["number","null"],"description":"Input or resolved location latitude. Null when the location has no single coordinate; omitted for timezone-only requests."},"longitude":{"type":["number","null"],"description":"Input or resolved location longitude. Null when the location has no single coordinate; omitted for timezone-only requests."},"to":{"type":["object","null"],"required":["at","unix","timezone","abbreviation","offset","dst"],"properties":{"at":{"type":"string","description":"Local ISO datetime with its UTC offset. Nonzero milliseconds are preserved. Historical subminute offsets use ±HH:MM:SS; consume unix if your date parser only supports whole-minute offsets."},"unix":{"type":"integer","description":"Unix seconds for this instant, rounded down."},"timezone":{"type":"string","description":"IANA timezone identifier; UTC for the bare route."},"abbreviation":{"type":["string","null"]},"offset":{"type":"string","pattern":"^[+-]\\d{2}:\\d{2}(?::\\d{2})?$"},"dst":{"type":"boolean","description":"Timezone-rule daylight-saving indicator, including negative seasonal adjustments."},"name":{"type":["string","null"]},"offset_minutes":{"type":"integer","description":"Whole offset minutes, truncated toward zero."},"offset_seconds":{"type":"integer","description":"Exact offset seconds, including historical subminute offsets."}}},"targets":{"type":["array","null"],"minItems":1,"maxItems":10,"description":"Requested destinations in order, or null if the source location cannot resolve to one timezone.","items":{"type":"object","required":["at","unix","timezone","abbreviation","offset","dst"],"properties":{"at":{"type":"string","description":"Local ISO datetime with its UTC offset. Nonzero milliseconds are preserved. Historical subminute offsets use ±HH:MM:SS; consume unix if your date parser only supports whole-minute offsets."},"unix":{"type":"integer","description":"Unix seconds for this instant, rounded down."},"timezone":{"type":"string","description":"IANA timezone identifier; UTC for the bare route."},"abbreviation":{"type":["string","null"]},"offset":{"type":"string","pattern":"^[+-]\\d{2}:\\d{2}(?::\\d{2})?$"},"dst":{"type":"boolean","description":"Timezone-rule daylight-saving indicator, including negative seasonal adjustments."},"name":{"type":["string","null"]},"offset_minutes":{"type":"integer","description":"Whole offset minutes, truncated toward zero."},"offset_seconds":{"type":"integer","description":"Exact offset seconds, including historical subminute offsets."}}}},"location":{"type":"object","description":"Matched place on a resolved clock, with its name, state, country, public City id and available coordinates. When no clock is available, status, input, candidates and truncated describe the unresolved choices.","oneOf":[{"required":["input","status","candidates","truncated"]},{"minProperties":1,"not":{"anyOf":[{"required":["input"]},{"required":["status"]},{"required":["candidates"]},{"required":["truncated"]}]}}],"properties":{"name":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"id":{"type":"string","pattern":"^city_[a-zA-Z0-9]+$"},"input":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["ip","city","country","iata","icao","unlocode","address"]},"value":{"type":"string"}}},"status":{"type":"string","enum":["ambiguous","not_found"]},"candidates":{"type":"array","maxItems":50,"items":{"type":"object","description":"Matched identity and per-choice facts. Unknown context is omitted. Resolved clock/point facts live on the root response. Country scope is not repeated.","properties":{"name":{"type":["string","null"],"description":"Matched location name. Omitted when it repeats the timezone identifier."},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"timezone":{"type":["string","null"],"description":"Per-choice timezone for ambiguous or unresolved locations. Resolved timezone is on the clock response."},"latitude":{"type":["number","null"],"description":"Per-choice latitude for ambiguous or unresolved locations. Resolved coordinates are on the clock response."},"longitude":{"type":["number","null"],"description":"Per-choice longitude for ambiguous or unresolved locations. Resolved coordinates are on the clock response."},"id":{"type":"string","pattern":"^city_[a-zA-Z0-9]+$","description":"Public City identifier when available. Omitted for other location types."}}}},"truncated":{"type":"boolean","description":"More candidates may exist. Narrow city/address context; never infer uniqueness from a truncated result."}}},"name":{"type":["string","null"]},"offset_minutes":{"type":["integer","null"],"description":"Whole offset minutes, truncated toward zero."},"offset_seconds":{"type":["integer","null"],"description":"Exact offset seconds, including historical subminute offsets."},"next_dst":{"type":["object","null"],"description":"Next known UTC offset transition within 400 days, or null.","properties":{"at":{"type":"string","description":"UTC ISO timestamp; expanded years are possible beyond year 9999."},"dst":{"type":"boolean"},"offset":{"type":"string"},"abbreviation":{"type":["string","null"]}}},"resolution":{"type":"object","description":"Actual offsetless source-wall conversion outcome. Omitted for now, explicit-offset input, no destination or an unresolved source location. Source optional detail only.","required":["kind","policy","adjustment_seconds","alternatives"],"properties":{"kind":{"type":"string","enum":["unique","overlap","gap"]},"policy":{"type":"string","enum":["compatible","earlier","later","reject"]},"adjustment_seconds":{"type":"integer","description":"Resolved source wall time minus requested wall time, in seconds. Zero for unique times and overlaps."},"alternatives":{"type":"array","maxItems":2,"description":"Empty for unique time; earlier and later choices in chronological instant order for overlap or gap. Gap choices shift the requested wall clock; neither is a match for the skipped time.","items":{"type":"object","required":["at","unix","offset"],"properties":{"at":{"type":"string","description":"Local ISO datetime with its UTC offset. Nonzero milliseconds are preserved. Historical subminute offsets use ±HH:MM:SS; consume unix if your date parser only supports whole-minute offsets."},"unix":{"type":"integer","description":"Unix seconds for this instant, rounded down."},"offset":{"type":"string","pattern":"^[+-]\\d{2}:\\d{2}(?::\\d{2})?$"}}}}}},"standard_offset":{"type":["string","null"],"description":"Standard UTC offset from the rules at the requested instant. May include historical seconds."},"standard_offset_seconds":{"type":["integer","null"],"description":"Exact standard UTC offset in seconds."},"dst_offset_seconds":{"type":["integer","null"],"description":"Total offset minus standard offset at the instant, including negative adjustments and double daylight saving."},"season":{"type":["object","null"],"required":["start","end"],"description":"Current interval with the DST rule flag, or the next one beginning within 400 days. start/end may independently be null when unavailable. Null when no such interval is known. Political changes without a DST flag are not seasons.","properties":{"start":{"type":["object","null"],"required":["at","before","after","change_seconds"],"description":"One boundary instant in UTC, with that boundary expressed using the old and new offsets. before.at is the old-clock boundary, not a separately observed earlier instant. Null when no recorded boundary is available.","properties":{"at":{"type":"string"},"before":{"type":"object","required":["at","offset","offset_seconds","abbreviation","dst"],"properties":{"at":{"type":"string"},"offset":{"type":"string"},"offset_seconds":{"type":"integer"},"abbreviation":{"type":["string","null"]},"dst":{"type":"boolean"}}},"after":{"type":"object","required":["at","offset","offset_seconds","abbreviation","dst"],"properties":{"at":{"type":"string"},"offset":{"type":"string"},"offset_seconds":{"type":"integer"},"abbreviation":{"type":["string","null"]},"dst":{"type":"boolean"}}},"change_seconds":{"type":"integer"}}},"end":{"type":["object","null"],"required":["at","before","after","change_seconds"],"description":"One boundary instant in UTC, with that boundary expressed using the old and new offsets. before.at is the old-clock boundary, not a separately observed earlier instant. Null when no recorded boundary is available.","properties":{"at":{"type":"string"},"before":{"type":"object","required":["at","offset","offset_seconds","abbreviation","dst"],"properties":{"at":{"type":"string"},"offset":{"type":"string"},"offset_seconds":{"type":"integer"},"abbreviation":{"type":["string","null"]},"dst":{"type":"boolean"}}},"after":{"type":"object","required":["at","offset","offset_seconds","abbreviation","dst"],"properties":{"at":{"type":"string"},"offset":{"type":"string"},"offset_seconds":{"type":"integer"},"abbreviation":{"type":["string","null"]},"dst":{"type":"boolean"}}},"change_seconds":{"type":"integer"}}}}}}}}}},"400":{"description":"invalid_request, ambiguous_time or nonexistent_time","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/time/{timezone}":{"get":{"operationId":"time","tags":["Time"],"summary":"Get local time in a timezone, or convert it to another zone","description":"Returns the current local ISO datetime and Unix timestamp, timezone, offset, abbreviation and DST. Pooled deep adds name, numeric and standard offsets, seasonal boundaries, the next clock change and local-wall resolution. Pass at for a specific moment and to for one destination or targets for up to ten. All unix values match. One pooled request on every plan. Full field reference: https://parseapi.com/docs/time","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"timezone","in":"path","required":true,"description":"IANA timezone identifier. Slashes may be literal or URL-encoded","schema":{"type":"string","maxLength":64,"example":"America/New_York"}},{"name":"at","in":"query","required":false,"description":"ISO date and time with up to three fractional-second digits; defaults to now. Unix numbers are not accepted as input. An explicit Z or UTC offset identifies an instant. With to= or targets=, no offset means source-zone wall time; without either, no offset means UTC. By default, repeated wall times select the earlier occurrence and skipped times advance by the offset gap. Use disambiguation to choose another policy. Invalid calendar dates return 400.","schema":{"type":"string","maxLength":40,"example":"2026-08-29T19:00:00Z"}},{"name":"to","in":"query","required":false,"description":"Destination IANA timezone. Appends to with local at, unix, timezone, abbreviation, offset, and dst for the same instant. deep=true adds name, offset_minutes, and offset_seconds at to.name, to.offset_minutes and to.offset_seconds.","schema":{"type":"string","maxLength":64,"example":"Asia/Tokyo"}},{"name":"disambiguation","in":"query","required":false,"description":"For offsetless at with to or targets: compatible selects the earlier repeated time and advances skipped times by the clock gap; earlier or later chooses the earlier or later instant; reject returns HTTP 400 ambiguous_time for a repeat or nonexistent_time for a gap. Branch on code, then ask for a choice before retrying. Valid values do not alter an explicit-offset instant, now, or the UTC interpretation without a destination. Invalid policies return 400 invalid_request.","schema":{"type":"string","enum":["compatible","earlier","later","reject"],"default":"compatible"}},{"name":"targets","in":"query","required":false,"description":"Comma-separated list of 1–10 IANA destination identifiers, instead of to. Appends an ordered targets array with one compact clock per requested zone. Duplicates stay in place, all unix values match, and any unknown zone rejects the whole request. One pooled request for the entire conversion. deep=true adds numeric offsets and a name to each target.","schema":{"type":"string","minLength":1,"maxLength":649,"example":"Europe/London,Asia/Tokyo"}},{"name":"deep","in":"query","required":false,"description":"Friendly zone name, numeric offsets, clock changes, seasonal boundaries and local-time resolution. Included automatically on paid plans in API 2.2. Existing accounts retain their current profile access.","schema":{"type":"boolean","enum":[true]}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","required":["at","unix","timezone","abbreviation","offset","dst"],"properties":{"at":{"type":"string","description":"Local ISO datetime with its UTC offset. Nonzero milliseconds are preserved. Historical subminute offsets use ±HH:MM:SS; consume unix if your date parser only supports whole-minute offsets."},"unix":{"type":"integer","description":"Unix seconds for this instant, rounded down."},"timezone":{"type":"string","description":"IANA timezone identifier; UTC for the bare route."},"abbreviation":{"type":["string","null"]},"offset":{"type":"string","pattern":"^[+-]\\d{2}:\\d{2}(?::\\d{2})?$"},"dst":{"type":"boolean","description":"Timezone-rule daylight-saving indicator, including negative seasonal adjustments."},"latitude":{"type":"number","description":"Input latitude when coordinates are supplied."},"longitude":{"type":"number","description":"Input longitude when coordinates are supplied."},"to":{"type":"object","required":["at","unix","timezone","abbreviation","offset","dst"],"properties":{"at":{"type":"string","description":"Local ISO datetime with its UTC offset. Nonzero milliseconds are preserved. Historical subminute offsets use ±HH:MM:SS; consume unix if your date parser only supports whole-minute offsets."},"unix":{"type":"integer","description":"Unix seconds for this instant, rounded down."},"timezone":{"type":"string","description":"IANA timezone identifier; UTC for the bare route."},"abbreviation":{"type":["string","null"]},"offset":{"type":"string","pattern":"^[+-]\\d{2}:\\d{2}(?::\\d{2})?$"},"dst":{"type":"boolean","description":"Timezone-rule daylight-saving indicator, including negative seasonal adjustments."},"name":{"type":["string","null"]},"offset_minutes":{"type":"integer","description":"Whole offset minutes, truncated toward zero."},"offset_seconds":{"type":"integer","description":"Exact offset seconds, including historical subminute offsets."}}},"targets":{"type":"array","minItems":1,"maxItems":10,"description":"Present only when targets is requested. Request order and duplicates are preserved.","items":{"type":"object","required":["at","unix","timezone","abbreviation","offset","dst"],"properties":{"at":{"type":"string","description":"Local ISO datetime with its UTC offset. Nonzero milliseconds are preserved. Historical subminute offsets use ±HH:MM:SS; consume unix if your date parser only supports whole-minute offsets."},"unix":{"type":"integer","description":"Unix seconds for this instant, rounded down."},"timezone":{"type":"string","description":"IANA timezone identifier; UTC for the bare route."},"abbreviation":{"type":["string","null"]},"offset":{"type":"string","pattern":"^[+-]\\d{2}:\\d{2}(?::\\d{2})?$"},"dst":{"type":"boolean","description":"Timezone-rule daylight-saving indicator, including negative seasonal adjustments."},"name":{"type":["string","null"]},"offset_minutes":{"type":"integer","description":"Whole offset minutes, truncated toward zero."},"offset_seconds":{"type":"integer","description":"Exact offset seconds, including historical subminute offsets."}}}},"name":{"type":["string","null"]},"offset_minutes":{"type":"integer","description":"Whole offset minutes, truncated toward zero."},"offset_seconds":{"type":"integer","description":"Exact offset seconds, including historical subminute offsets."},"next_dst":{"type":["object","null"],"description":"Next known UTC offset transition within 400 days, or null.","properties":{"at":{"type":"string","description":"UTC ISO timestamp; expanded years are possible beyond year 9999."},"dst":{"type":"boolean"},"offset":{"type":"string"},"abbreviation":{"type":["string","null"]}}},"resolution":{"type":"object","description":"Actual offsetless source-wall conversion outcome. Omitted for now, explicit-offset input, no destination or an unresolved source location. Source optional detail only.","required":["kind","policy","adjustment_seconds","alternatives"],"properties":{"kind":{"type":"string","enum":["unique","overlap","gap"]},"policy":{"type":"string","enum":["compatible","earlier","later","reject"]},"adjustment_seconds":{"type":"integer","description":"Resolved source wall time minus requested wall time, in seconds. Zero for unique times and overlaps."},"alternatives":{"type":"array","maxItems":2,"description":"Empty for unique time; earlier and later choices in chronological instant order for overlap or gap. Gap choices shift the requested wall clock; neither is a match for the skipped time.","items":{"type":"object","required":["at","unix","offset"],"properties":{"at":{"type":"string","description":"Local ISO datetime with its UTC offset. Nonzero milliseconds are preserved. Historical subminute offsets use ±HH:MM:SS; consume unix if your date parser only supports whole-minute offsets."},"unix":{"type":"integer","description":"Unix seconds for this instant, rounded down."},"offset":{"type":"string","pattern":"^[+-]\\d{2}:\\d{2}(?::\\d{2})?$"}}}}}},"standard_offset":{"type":["string","null"],"description":"Standard UTC offset from the rules at the requested instant. May include historical seconds."},"standard_offset_seconds":{"type":["integer","null"],"description":"Exact standard UTC offset in seconds."},"dst_offset_seconds":{"type":["integer","null"],"description":"Total offset minus standard offset at the instant, including negative adjustments and double daylight saving."},"season":{"type":["object","null"],"required":["start","end"],"description":"Current interval with the DST rule flag, or the next one beginning within 400 days. start/end may independently be null when unavailable. Null when no such interval is known. Political changes without a DST flag are not seasons.","properties":{"start":{"type":["object","null"],"required":["at","before","after","change_seconds"],"description":"One boundary instant in UTC, with that boundary expressed using the old and new offsets. before.at is the old-clock boundary, not a separately observed earlier instant. Null when no recorded boundary is available.","properties":{"at":{"type":"string"},"before":{"type":"object","required":["at","offset","offset_seconds","abbreviation","dst"],"properties":{"at":{"type":"string"},"offset":{"type":"string"},"offset_seconds":{"type":"integer"},"abbreviation":{"type":["string","null"]},"dst":{"type":"boolean"}}},"after":{"type":"object","required":["at","offset","offset_seconds","abbreviation","dst"],"properties":{"at":{"type":"string"},"offset":{"type":"string"},"offset_seconds":{"type":"integer"},"abbreviation":{"type":["string","null"]},"dst":{"type":"boolean"}}},"change_seconds":{"type":"integer"}}},"end":{"type":["object","null"],"required":["at","before","after","change_seconds"],"description":"One boundary instant in UTC, with that boundary expressed using the old and new offsets. before.at is the old-clock boundary, not a separately observed earlier instant. Null when no recorded boundary is available.","properties":{"at":{"type":"string"},"before":{"type":"object","required":["at","offset","offset_seconds","abbreviation","dst"],"properties":{"at":{"type":"string"},"offset":{"type":"string"},"offset_seconds":{"type":"integer"},"abbreviation":{"type":["string","null"]},"dst":{"type":"boolean"}}},"after":{"type":"object","required":["at","offset","offset_seconds","abbreviation","dst"],"properties":{"at":{"type":"string"},"offset":{"type":"string"},"offset_seconds":{"type":"integer"},"abbreviation":{"type":["string","null"]},"dst":{"type":"boolean"}}},"change_seconds":{"type":"integer"}}}}}}}}}},"400":{"description":"invalid_request, ambiguous_time or nonexistent_time","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/date/{date}":{"get":{"operationId":"date","tags":["Date"],"summary":"Parse a date","description":"Parses ISO, spelled months (March 29, 2026 / 29 Aug 2026), numeric (3/29/2026), and compact (20260829) into ISO date, validity and Unix time. Pooled deep adds calendar components, weekday, ISO week, quarter and leap-year detail. Ambiguous numeric dates answer valid false unless format= asserts a reading. Junk is a 200 with valid false, never a 404. Add to= for the signed days between two dates. Full field reference: https://parseapi.com/docs/date","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"date","in":"path","required":true,"description":"The date as you have it","schema":{"type":"string","example":"March 29, 2026"}},{"name":"format","in":"query","required":false,"description":"mdy or dmy. Breaks the tie on numeric dates where both readings are real days (03/04/2026). Applies to to= as well","schema":{"type":"string","enum":["mdy","dmy"]}},{"name":"to","in":"query","required":false,"description":"Another date. Appends to (normalized ISO) and days (signed days between)","schema":{"type":"string","example":"2026-12-25"}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"deep","in":"query","required":false,"description":"Calendar components, ISO week, quarter and leap-year detail. Included automatically on paid plans in API 2.2. Existing accounts retain their current profile access.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"date":{"type":"string"},"valid":{"type":"boolean"},"unix":{"type":["integer","null"]},"to":{"type":"string"},"days":{"type":["integer","null"]},"year":{"type":["integer","null"]},"month":{"type":["integer","null"]},"month_name":{"type":["string","null"]},"day":{"type":["integer","null"]},"weekday":{"type":["integer","null"]},"weekday_name":{"type":["string","null"]},"week":{"type":["integer","null"]},"week_year":{"type":["integer","null"]},"day_of_year":{"type":["integer","null"]},"quarter":{"type":["integer","null"]},"leap":{"type":["boolean","null"]},"days_in_month":{"type":["integer","null"]}},"required":["date","valid","unix"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/date":{"get":{"operationId":"date_today","tags":["Date"],"summary":"Today (UTC)","description":"Normalized date, validity and Unix time for today in UTC; calendar detail is optional pooled deep. Add to= for days from today: /date?to=2026-12-25 is days until Christmas. Full field reference: https://parseapi.com/docs/date","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"to","in":"query","required":false,"description":"Another date. Appends to and days (signed days from today)","schema":{"type":"string","example":"2026-12-25"}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"deep","in":"query","required":false,"description":"Calendar components, ISO week, quarter and leap-year detail. Included automatically on paid plans in API 2.2. Existing accounts retain their current profile access.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"date":{"type":"string"},"valid":{"type":"boolean"},"unix":{"type":["integer","null"]},"to":{"type":"string"},"days":{"type":["integer","null"]},"year":{"type":["integer","null"]},"month":{"type":["integer","null"]},"month_name":{"type":["string","null"]},"day":{"type":["integer","null"]},"weekday":{"type":["integer","null"]},"weekday_name":{"type":["string","null"]},"week":{"type":["integer","null"]},"week_year":{"type":["integer","null"]},"day_of_year":{"type":["integer","null"]},"quarter":{"type":["integer","null"]},"leap":{"type":["boolean","null"]},"days_in_month":{"type":["integer","null"]}},"required":["date","valid","unix"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/elevation":{"get":{"operationId":"elevation","tags":["Elevation"],"summary":"Elevation at a point, a list, or evenly along a path","description":"Pass lat and lon for one point, points for a list, or path with samples for an evenly sampled path. Do not combine them. samples is required with path and invalid without it. A single lookup returns one elevation object; a list or path returns an ordered points array. Each request uses one pooled request on every plan. Full field reference: https://parseapi.com/docs/elevation","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"format","in":"query","required":false,"description":"json by default. geojson returns application/geo+json: a Point Feature for lat/lon, or an ordered FeatureCollection for points and path. The same limits and request allowance apply. Available in API 2.0.0.","schema":{"type":"string","enum":["json","geojson"],"default":"json"}},{"name":"lat","in":"query","required":false,"description":"Latitude. Required unless points or path is set.","schema":{"type":"number","minimum":-90,"maximum":90,"example":45.5}},{"name":"lon","in":"query","required":false,"description":"Longitude. Required unless points or path is set.","schema":{"type":"number","minimum":-180,"maximum":180,"example":-122.7}},{"name":"points","in":"query","required":false,"description":"lat,lon pairs separated by a pipe, or enc: followed by a Google encoded polyline at precision 5. At most 512 points and 12000 characters. URL-encode the value and omit lat and lon. POST /elevation with a JSON points array when the list does not fit in the URL; the 512-point limit still applies.","schema":{"type":"string","minLength":1,"maxLength":12000,"description":"lat,lon pairs separated by |, or enc: followed by a Google encoded polyline at precision 5. At most 512 decoded points.","example":"39.7392,-104.9903|40.71,-74.01"}},{"name":"path","in":"query","required":false,"description":"Ordered path vertices. Requires samples. Omit lat, lon and points. The returned points are evenly spaced by cumulative great-circle distance, including endpoints. Repeated vertices are supported; an all-identical path returns repeated coordinates.","schema":{"type":"string","minLength":1,"maxLength":12000,"description":"A path of 2-512 ordered vertices as lat,lon pairs separated by |, or an enc: polyline at precision 5. Segments follow shortest great-circle arcs. Antipodal segments are invalid.","example":"39.7392,-104.9903|40.71,-74.01"}},{"name":"samples","in":"query","required":false,"description":"Number of results along path, including both endpoints. Required only with path; no default.","schema":{"type":"integer","minimum":2,"maximum":512,"example":65}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["latitude","longitude","elevation","elevation_ft","resolution"],"properties":{"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"elevation":{"type":["integer","null"],"description":"Meters relative to the EGM2008 geoid. Negative below that reference; null when unavailable."},"elevation_ft":{"type":["integer","null"],"description":"Feet relative to the EGM2008 geoid. Negative below that reference; null when unavailable."},"resolution":{"type":["integer","null"],"description":"Approximate horizontal grid spacing in meters, not vertical accuracy."}}},{"type":"object","required":["points"],"properties":{"points":{"type":"array","minItems":1,"maxItems":512,"items":{"type":"object","required":["latitude","longitude","elevation","elevation_ft","resolution"],"properties":{"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"elevation":{"type":["integer","null"],"description":"Meters relative to the EGM2008 geoid. Negative below that reference; null when unavailable."},"elevation_ft":{"type":["integer","null"],"description":"Feet relative to the EGM2008 geoid. Negative below that reference; null when unavailable."},"resolution":{"type":["integer","null"],"description":"Approximate horizontal grid spacing in meters, not vertical accuracy."}}},"description":"For points, one result per input coordinate in the same order. Duplicate coordinates retain their positions. For path, exactly samples evenly spaced results along the path, including both endpoints."}}}]}},"application/geo+json":{"schema":{"oneOf":[{"type":"object","required":["type","geometry","properties"],"properties":{"type":{"type":"string","const":"Feature"},"geometry":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","const":"Point"},"coordinates":{"type":"array","minItems":2,"maxItems":2,"prefixItems":[{"type":"number","minimum":-180,"maximum":180},{"type":"number","minimum":-90,"maximum":90}],"items":false,"description":"[longitude, latitude] in WGS84. Height stays in properties because its reference is EGM2008, not ellipsoid altitude."}}},"properties":{"type":"object","required":["elevation","elevation_ft","resolution"],"properties":{"elevation":{"type":["integer","null"],"description":"Meters relative to the EGM2008 geoid. Negative below that reference; null when unavailable."},"elevation_ft":{"type":["integer","null"],"description":"Feet relative to the EGM2008 geoid. Negative below that reference; null when unavailable."},"resolution":{"type":["integer","null"],"description":"Approximate horizontal grid spacing in meters, not vertical accuracy."}}}}},{"type":"object","required":["type","features"],"properties":{"type":{"type":"string","const":"FeatureCollection"},"features":{"type":"array","minItems":1,"maxItems":512,"items":{"type":"object","required":["type","geometry","properties"],"properties":{"type":{"type":"string","const":"Feature"},"geometry":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","const":"Point"},"coordinates":{"type":"array","minItems":2,"maxItems":2,"prefixItems":[{"type":"number","minimum":-180,"maximum":180},{"type":"number","minimum":-90,"maximum":90}],"items":false,"description":"[longitude, latitude] in WGS84. Height stays in properties because its reference is EGM2008, not ellipsoid altitude."}}},"properties":{"type":"object","required":["elevation","elevation_ft","resolution"],"properties":{"elevation":{"type":["integer","null"],"description":"Meters relative to the EGM2008 geoid. Negative below that reference; null when unavailable."},"elevation_ft":{"type":["integer","null"],"description":"Feet relative to the EGM2008 geoid. Negative below that reference; null when unavailable."},"resolution":{"type":["integer","null"],"description":"Approximate horizontal grid spacing in meters, not vertical accuracy."}}}}},"description":"One Point Feature per returned sample, in the same order, including duplicates and null heights. A path returns exactly samples features, including endpoints."}}}]}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"elevation_points_post","tags":["Elevation"],"summary":"Elevation for a list or a sampled path in JSON","description":"Send 1-512 coordinates in points, or 2-512 vertices in path with an integer samples count from 2 to 512. Each pair is [latitude, longitude]. A pipe-separated string or enc: polyline at precision 5 is also accepted, limited to 12000 characters. Choose exactly one mode and put all selectors in the body. A path returns exactly samples results at uniform cumulative great-circle distances, including endpoints; antipodal segments are invalid. Each list or path uses one pooled request on every plan. Full field reference: https://parseapi.com/docs/elevation","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"format","in":"query","required":false,"description":"json by default. geojson returns application/geo+json: a Point Feature for lat/lon, or an ordered FeatureCollection for points and path. The same limits and request allowance apply. Available in API 2.0.0.","schema":{"type":"string","enum":["json","geojson"],"default":"json"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["points"],"additionalProperties":false,"properties":{"points":{"oneOf":[{"type":"array","minItems":1,"maxItems":512,"items":{"type":"array","minItems":2,"maxItems":2,"prefixItems":[{"type":"number","minimum":-90,"maximum":90},{"type":"number","minimum":-180,"maximum":180}],"items":false}},{"type":"string","minLength":1,"maxLength":12000,"description":"lat,lon pairs separated by |, or enc: followed by a Google encoded polyline at precision 5. At most 512 decoded points.","example":"39.7392,-104.9903|40.71,-74.01"}]}}},{"type":"object","required":["path","samples"],"additionalProperties":false,"properties":{"path":{"oneOf":[{"type":"array","minItems":2,"maxItems":512,"items":{"type":"array","minItems":2,"maxItems":2,"prefixItems":[{"type":"number","minimum":-90,"maximum":90},{"type":"number","minimum":-180,"maximum":180}],"items":false}},{"type":"string","minLength":1,"maxLength":12000,"description":"A path of 2-512 ordered vertices as lat,lon pairs separated by |, or an enc: polyline at precision 5. Segments follow shortest great-circle arcs. Antipodal segments are invalid.","example":"39.7392,-104.9903|40.71,-74.01"}]},"samples":{"type":"integer","minimum":2,"maximum":512,"example":65}}}]},"example":{"path":[[39.74,-104.99],[39.74,-105.63]],"samples":65}}}},"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","required":["points"],"properties":{"points":{"type":"array","minItems":1,"maxItems":512,"items":{"type":"object","required":["latitude","longitude","elevation","elevation_ft","resolution"],"properties":{"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"elevation":{"type":["integer","null"],"description":"Meters relative to the EGM2008 geoid. Negative below that reference; null when unavailable."},"elevation_ft":{"type":["integer","null"],"description":"Feet relative to the EGM2008 geoid. Negative below that reference; null when unavailable."},"resolution":{"type":["integer","null"],"description":"Approximate horizontal grid spacing in meters, not vertical accuracy."}}},"description":"For points, one result per input coordinate in the same order. Duplicate coordinates retain their positions. For path, exactly samples evenly spaced results along the path, including both endpoints."}}}},"application/geo+json":{"schema":{"type":"object","required":["type","features"],"properties":{"type":{"type":"string","const":"FeatureCollection"},"features":{"type":"array","minItems":1,"maxItems":512,"items":{"type":"object","required":["type","geometry","properties"],"properties":{"type":{"type":"string","const":"Feature"},"geometry":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","const":"Point"},"coordinates":{"type":"array","minItems":2,"maxItems":2,"prefixItems":[{"type":"number","minimum":-180,"maximum":180},{"type":"number","minimum":-90,"maximum":90}],"items":false,"description":"[longitude, latitude] in WGS84. Height stays in properties because its reference is EGM2008, not ellipsoid altitude."}}},"properties":{"type":"object","required":["elevation","elevation_ft","resolution"],"properties":{"elevation":{"type":["integer","null"],"description":"Meters relative to the EGM2008 geoid. Negative below that reference; null when unavailable."},"elevation_ft":{"type":["integer","null"],"description":"Feet relative to the EGM2008 geoid. Negative below that reference; null when unavailable."},"resolution":{"type":["integer","null"],"description":"Approximate horizontal grid spacing in meters, not vertical accuracy."}}}}},"description":"One Point Feature per returned sample, in the same order, including duplicates and null heights. A path returns exactly samples features, including endpoints."}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/point":{"get":{"operationId":"point","tags":["Point"],"summary":"Place and time zone at a latitude/longitude","description":"Locate the supplied coordinates. Core includes the point’s geography and timezone on every plan. Deep adds a compact nearest-city summary within 200 km, including city.id for /city/id/{id} and straight-line distance, or city: null when unavailable; the point’s geography is retained. In API 2.2.0, paid requests include terrain, nearest-city detail, electoral.code, electoral.name and electoral.congress automatically in the same pooled API request, with no additional unit. Electoral uses the exact point and supported US congressional boundaries for the 119th Congress. A boundary point, multiple matches, unsupported area, or unavailable boundary data returns electoral: null in the requested detail. The electoral object identifies the area for the national lower-house or sole legislative chamber. electoral.code is an opaque country-specific string in the current boundary edition, preserving letters and leading zeros; it is not a globally unique or permanent identifier. electoral.congress is the US Congress number and is null for other national legislatures. electoral.name is the official name, currently the literal Census name for the matched US district, or null when a verified name is unavailable. US electoral area codes use state FIPS plus district, with 00 for at-large and 98 for delegate districts; 99 is unsupported. The administrative county reference retains its existing meaning. Free requests omit electoral detail unless existing access and an explicit request include it. The frozen 1.0.0 contract is unchanged. Full field reference: https://parseapi.com/docs/point","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"format","in":"query","required":false,"description":"Optional geojson returns a Feature: exact [longitude, latitude] geometry and the same selected facts in properties. Content-Type: application/geo+json. Omit for ordinary JSON.","schema":{"type":"string","enum":["geojson"]}},{"name":"lat","in":"query","required":true,"description":"Latitude","schema":{"type":"number","example":39.77}},{"name":"lon","in":"query","required":true,"description":"Longitude","schema":{"type":"number","example":-104.9}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"deep","in":"query","required":false,"description":"Terrain elevation, a compact nearest-city summary, and supported US electoral area code, name and Congress number. Included automatically on paid plans in API 2.2. Existing accounts retain their current profile access.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"timezone":{"type":["string","null"]},"city":{"type":["object","null"],"properties":{"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":"string"},"country_name":{"type":["string","null"]},"name":{"type":"string"},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"distance":{"type":"number"},"distance_mi":{"type":"number"},"id":{"type":"string"}},"required":["name","name_local","type","state","state_name","country","country_name","latitude","longitude","distance","distance_mi","id"],"additionalProperties":true},"elevation":{"type":["number","null"]},"elevation_ft":{"type":["number","null"]},"electoral":{"type":["object","null"],"properties":{"code":{"type":"string"},"name":{"type":["string","null"]},"congress":{"type":["number","null"]}},"required":["code","name","congress"],"additionalProperties":true,"description":"National lower-house or sole legislative chamber electoral area containing code, name and congress, or null without a unique supported match. The code belongs to a country-specific source and current boundary edition. Current coverage is US congressional districts for the 119th Congress. Uses the supplied exact coordinates, independently of the administrative county."}},"required":["latitude","longitude","county","county_name","state","state_name","country","country_name","timezone"],"additionalProperties":true}},"application/geo+json":{"schema":{"type":"object","required":["type","geometry","properties"],"properties":{"type":{"type":"string","const":"Feature"},"geometry":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","const":"Point"},"coordinates":{"type":"array","minItems":2,"maxItems":2,"prefixItems":[{"type":"number","minimum":-180,"maximum":180},{"type":"number","minimum":-90,"maximum":90}]}}},"properties":{"type":"object","properties":{"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"timezone":{"type":["string","null"]},"city":{"type":["object","null"],"properties":{"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":"string"},"country_name":{"type":["string","null"]},"name":{"type":"string"},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"distance":{"type":"number"},"distance_mi":{"type":"number"},"id":{"type":"string"}},"required":["name","name_local","type","state","state_name","country","country_name","latitude","longitude","distance","distance_mi","id"],"additionalProperties":true},"elevation":{"type":["number","null"]},"elevation_ft":{"type":["number","null"]},"electoral":{"type":["object","null"],"properties":{"code":{"type":"string"},"name":{"type":["string","null"]},"congress":{"type":["number","null"]}},"required":["code","name","congress"],"additionalProperties":true,"description":"National lower-house or sole legislative chamber electoral area containing code, name and congress, or null without a unique supported match. The code belongs to a country-specific source and current boundary edition. Current coverage is US congressional districts for the 119th Congress. Uses the supplied exact coordinates, independently of the administrative county."}},"required":["county","county_name","state","state_name","country","country_name","timezone"],"additionalProperties":true}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/weather":{"get":{"operationId":"weather","tags":["Weather"],"summary":"Current conditions at a latitude/longitude","description":"Current conditions at a latitude and longitude. Full field reference: https://parseapi.com/docs/weather","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"lat","in":"query","required":true,"description":"Latitude","schema":{"type":"number","example":40.7128}},{"name":"lon","in":"query","required":true,"description":"Longitude","schema":{"type":"number","example":-74.006}},{"name":"date","in":"query","required":false,"description":"A past UTC day (YYYY-MM-DD). With deep, that day rides history","schema":{"type":"string","example":"2026-08-15"}},{"name":"deep","in":"query","required":false,"description":"Additional current measurements, forecasts, radar rain, alerts, air quality and requested historical detail. Included automatically on paid plans in API 2.2.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"current":{"type":"object","properties":{"temperature":{"type":["number","null"]},"temperature_f":{"type":["number","null"]},"feels_like":{"type":["number","null"]},"feels_like_f":{"type":["number","null"]},"humidity":{"type":["number","null"]},"wind_speed":{"type":["number","null"]},"wind_speed_mph":{"type":["number","null"]},"wind_direction":{"type":["number","null"]},"condition":{"type":["string","null"]},"condition_name":{"type":["string","null"]},"condition_emoji":{"type":["string","null"]},"observed_at":{"type":["string","null"]},"dewpoint":{"type":["number","null"]},"dewpoint_f":{"type":["number","null"]},"wind_gust":{"type":["number","null"]},"wind_gust_mph":{"type":["number","null"]},"pressure":{"type":["number","null"]},"pressure_inhg":{"type":["number","null"]},"visibility":{"type":["number","null"]},"visibility_mi":{"type":["number","null"]}},"required":["temperature","temperature_f","feels_like","feels_like_f","humidity","wind_speed","wind_speed_mph","wind_direction","condition","condition_name","condition_emoji","observed_at"],"additionalProperties":true},"station":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"distance":{"type":["number","null"]},"distance_mi":{"type":["number","null"]}},"required":["id","name","distance","distance_mi"],"additionalProperties":true},"forecast":{"type":["array","null"],"items":{"type":"object","properties":{"name":{"type":"string"},"start":{"type":["string","null"]},"end":{"type":["string","null"]},"daytime":{"type":["boolean","null"]},"temperature":{"type":["number","null"]},"temperature_f":{"type":["number","null"]},"precipitation_chance":{"type":["number","null"]},"wind_speed":{"type":["number","null"]},"wind_speed_mph":{"type":["number","null"]},"wind_direction":{"type":["number","null"]},"condition":{"type":["string","null"]},"condition_name":{"type":["string","null"]},"condition_emoji":{"type":["string","null"]}},"required":["name","start","end","daytime","temperature","temperature_f","precipitation_chance","wind_speed","wind_speed_mph","wind_direction","condition","condition_name","condition_emoji"],"additionalProperties":true}},"alerts":{"type":["array","null"],"items":{"type":"object","properties":{"event":{"type":"string"},"severity":{"type":["string","null"]},"urgency":{"type":["string","null"]},"headline":{"type":["string","null"]},"onset":{"type":["string","null"]},"expires":{"type":["string","null"]}},"required":["event","severity","urgency","headline","onset","expires"],"additionalProperties":true}},"minutes":{"type":["array","null"],"items":{"type":"object","properties":{"at":{"type":"string"},"precipitation_rate":{"type":["number","null"]},"precipitation_rate_in":{"type":["number","null"]},"type":{"type":["string","null"]}},"required":["at","precipitation_rate","precipitation_rate_in","type"],"additionalProperties":true}},"hours":{"type":["array","null"],"items":{"type":"object","properties":{"at":{"type":["string","null"]},"daytime":{"type":["boolean","null"]},"temperature":{"type":["number","null"]},"temperature_f":{"type":["number","null"]},"feels_like":{"type":["number","null"]},"feels_like_f":{"type":["number","null"]},"humidity":{"type":["number","null"]},"precipitation_chance":{"type":["number","null"]},"wind_speed":{"type":["number","null"]},"wind_speed_mph":{"type":["number","null"]},"wind_gust":{"type":["number","null"]},"wind_gust_mph":{"type":["number","null"]},"wind_direction":{"type":["number","null"]},"condition":{"type":["string","null"]},"condition_name":{"type":["string","null"]},"condition_emoji":{"type":["string","null"]}},"required":["at","daytime","temperature","temperature_f","feels_like","feels_like_f","humidity","precipitation_chance","wind_speed","wind_speed_mph","wind_gust","wind_gust_mph","wind_direction","condition","condition_name","condition_emoji"],"additionalProperties":true}},"days":{"type":["array","null"],"items":{"type":"object","properties":{"date":{"type":"string"},"high":{"type":["number","null"]},"high_f":{"type":["number","null"]},"low":{"type":["number","null"]},"low_f":{"type":["number","null"]},"precipitation_chance":{"type":["number","null"]},"condition":{"type":["string","null"]},"condition_name":{"type":["string","null"]},"condition_emoji":{"type":["string","null"]},"sunrise":{"type":["string","null"]},"sunset":{"type":["string","null"]},"moon_phase":{"type":["string","null"]},"moon_phase_name":{"type":["string","null"]},"moon_phase_emoji":{"type":["string","null"]}},"required":["date","high","high_f","low","low_f","precipitation_chance","condition","condition_name","condition_emoji","sunrise","sunset","moon_phase","moon_phase_name","moon_phase_emoji"],"additionalProperties":true}},"air":{"type":["object","null"],"properties":{"aqi":{"type":["number","null"]},"aqi_name":{"type":["string","null"]},"pm2_5":{"type":["number","null"]},"pm10":{"type":["number","null"]}},"required":["aqi","aqi_name","pm2_5","pm10"],"additionalProperties":true},"history":{"type":["object","null"],"properties":{"date":{"type":"string"},"high":{"type":["number","null"]},"high_f":{"type":["number","null"]},"low":{"type":["number","null"]},"low_f":{"type":["number","null"]},"precipitation":{"type":["number","null"]},"precipitation_in":{"type":["number","null"]},"wind_max":{"type":["number","null"]},"wind_max_mph":{"type":["number","null"]},"sunrise":{"type":["string","null"]},"sunset":{"type":["string","null"]},"moon_phase":{"type":["string","null"]},"moon_phase_name":{"type":["string","null"]},"moon_phase_emoji":{"type":["string","null"]}},"required":["date","high","high_f","low","low_f","precipitation","precipitation_in","wind_max","wind_max_mph","sunrise","sunset","moon_phase","moon_phase_name","moon_phase_emoji"],"additionalProperties":true}},"required":["latitude","longitude","current","station"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/emoji/{emoji}":{"get":{"operationId":"emoji","tags":["Emoji"],"summary":"Resolve an emoji by character, shortcode, name, or codepoints","description":"Resolve, browse, and find emoji in text. Full field reference: https://parseapi.com/docs/emoji","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"emoji","in":"path","required":true,"description":"Character, shortcode, name or hex codepoints. Qualified and unqualified forms resolve to the canonical emoji.","schema":{"type":"string","example":"rocket"}},{"name":"shortcode_source","in":"query","required":false,"description":"Resolve from a named shortcode preset. Ambiguous aliases return 400. Slack and Discord are community presets.","schema":{"type":"string","enum":["cldr","github","slack","discord"]}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"deep","in":"query","required":false,"description":"Unicode detail, keywords, sourced shortcode presets, complete skin-tone variants and licensed artwork links. Included automatically on paid plans in API 2.2. Existing accounts retain their current profile access.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success (shape and representation vary by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","required":["emoji","name","shortcodes","category"],"properties":{"emoji":{"type":"string"},"name":{"type":["string","null"]},"shortcodes":{"type":"array","items":{"type":"string"}},"category":{"type":["string","null"]},"codepoints":{"type":"array","items":{"type":"string"}},"hex":{"type":["string","null"]},"status":{"type":["string","null"]},"version":{"type":["string","null"]},"keywords":{"type":"array","items":{"type":"string"}},"skins":{"type":"array","items":{"type":"object","required":["emoji","tone","unicode","hex"],"properties":{"emoji":{"type":"string"},"tone":{"type":"string"},"unicode":{"type":["string","null"]},"hex":{"type":["string","null"]}}}},"subcategory":{"type":["string","null"]},"base":{"type":"string"},"variants":{"type":"array","items":{"type":"object","required":["emoji","tones"],"properties":{"emoji":{"type":"string"},"tones":{"type":"array","items":{"type":"string"}}}}},"artwork":{"type":"object","additionalProperties":{"type":"object","properties":{"svg":{"type":"string","format":"uri"},"png":{"type":"object","propertyNames":{"pattern":"^[1-9][0-9]*$"},"additionalProperties":{"type":"string","format":"uri"}},"license":{"type":"string"},"license_url":{"type":"string","format":"uri"},"attribution":{"type":"string"}}}}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/emoji":{"get":{"operationId":"emoji_search","tags":["Emoji"],"summary":"Search or browse emoji with catalog filters and pagination","description":"Resolve, browse, and find emoji in text. Full field reference: https://parseapi.com/docs/emoji","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"q","in":"query","required":false,"description":"An emoji name or keyword. Omit to browse in emoji order.","schema":{"type":"string","minLength":1,"maxLength":256,"example":"rocket"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of results.","schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"offset","in":"query","required":false,"description":"Zero-based page offset.","schema":{"type":"integer","minimum":0,"default":0}},{"name":"category","in":"query","required":false,"description":"Category name from /emoji/categories.","schema":{"type":"string"}},{"name":"subcategory","in":"query","required":false,"description":"Subcategory from /emoji/categories.","schema":{"type":"string"}},{"name":"version","in":"query","required":false,"description":"Exact Emoji introduction version.","schema":{"type":"string","example":"18.0"}},{"name":"max_version","in":"query","required":false,"description":"Maximum Emoji introduction version.","schema":{"type":"string","example":"16.0"}},{"name":"include_skin_tones","in":"query","required":false,"description":"Include skin-tone variants. False leaves base emoji in results.","schema":{"type":"boolean","default":true}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"deep","in":"query","required":false,"description":"Unicode detail, keywords, sourced shortcode presets, complete skin-tone variants and licensed artwork links. Included automatically on paid plans in API 2.2. Existing accounts retain their current profile access.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success (shape and representation vary by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","required":["emojis"],"properties":{"q":{"type":"string"},"total":{"type":"integer","minimum":0},"next_offset":{"type":["integer","null"]},"emojis":{"type":"array","items":{"type":"object","required":["emoji","name","shortcodes","category"],"properties":{"emoji":{"type":"string"},"name":{"type":["string","null"]},"shortcodes":{"type":"array","items":{"type":"string"}},"category":{"type":["string","null"]},"codepoints":{"type":"array","items":{"type":"string"}},"hex":{"type":["string","null"]},"status":{"type":["string","null"]},"version":{"type":["string","null"]},"keywords":{"type":"array","items":{"type":"string"}},"skins":{"type":"array","items":{"type":"object","required":["emoji","tone","unicode","hex"],"properties":{"emoji":{"type":"string"},"tone":{"type":"string"},"unicode":{"type":["string","null"]},"hex":{"type":["string","null"]}}}},"subcategory":{"type":["string","null"]},"base":{"type":"string"},"variants":{"type":"array","items":{"type":"object","required":["emoji","tones"],"properties":{"emoji":{"type":"string"},"tones":{"type":"array","items":{"type":"string"}}}}},"artwork":{"type":"object","additionalProperties":{"type":"object","properties":{"svg":{"type":"string","format":"uri"},"png":{"type":"object","propertyNames":{"pattern":"^[1-9][0-9]*$"},"additionalProperties":{"type":"string","format":"uri"}},"license":{"type":"string"},"license_url":{"type":"string","format":"uri"},"attribution":{"type":"string"}}}}}}}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/emoji/categories":{"get":{"operationId":"emoji_categories","tags":["Emoji"],"summary":"List emoji categories and subcategories","description":"Resolve, browse, and find emoji in text. Full field reference: https://parseapi.com/docs/emoji","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"}],"responses":{"200":{"description":"Success (shape and representation vary by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","required":["categories"],"properties":{"categories":{"type":"array","items":{"type":"object","required":["category","subcategories"],"properties":{"category":{"type":"string"},"subcategories":{"type":"array","items":{"type":"string"}}}}}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/emoji/catalog":{"get":{"operationId":"emoji_catalog","tags":["Emoji"],"summary":"Download a compact JSON catalog for offline lookup, search and parsing","description":"Compact JSON for offline lookup, search, tone relationships and parsing. The same inventory maps and required source and artwork notices travel with the download. Language and filters affect the ETag. Full field reference: https://parseapi.com/docs/emoji","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"category","in":"query","required":false,"description":"Category from /emoji/categories.","schema":{"type":"string"}},{"name":"subcategory","in":"query","required":false,"description":"Subcategory from /emoji/categories.","schema":{"type":"string"}},{"name":"version","in":"query","required":false,"description":"Exact Emoji introduction version.","schema":{"type":"string"}},{"name":"max_version","in":"query","required":false,"description":"Maximum Emoji introduction version.","schema":{"type":"string"}},{"name":"include_skin_tones","in":"query","required":false,"description":"Include skin-tone variants.","schema":{"type":"boolean","default":true}},{"name":"If-None-Match","in":"header","required":false,"description":"Use the exact representation’s previous validator.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success (shape and representation vary by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"ETag":{"description":"Validator for the selected payload. Identity responses use its strong SHA-256 tag; compression-capable responses use a weak tag across content codings. Language and filters affect the payload validator.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["metadata","scope","total","emojis","forms","shortcodes","legacy"],"properties":{"metadata":{"type":"object","required":["edition","max_version","total","sources","artwork_sources","completeness","notices"],"properties":{"edition":{"type":"string"},"max_version":{"type":["string","null"]},"total":{"type":"integer","minimum":0},"sources":{"type":"array","items":{"type":"object","required":["id","source_url","license","license_url"],"properties":{"id":{"type":"string"},"source_url":{"type":"string","format":"uri"},"license":{"type":"string"},"license_url":{"type":"string","format":"uri"}}}},"artwork_sources":{"type":"array","items":{"type":"object","required":["style","unicode_version","source_url","license","license_url","attribution","notices","loaded_coverage"],"properties":{"style":{"type":"string"},"unicode_version":{"type":["string","null"]},"source_url":{"type":"string","format":"uri"},"license":{"type":"string"},"license_url":{"type":"string","format":"uri"},"attribution":{"type":"string"},"notices":{"type":"array","items":{"type":"string","format":"uri"}},"flag_license":{"type":"object","additionalProperties":true},"loaded_coverage":{"type":"object","required":["svg","png"],"properties":{"svg":{"type":"integer","minimum":0},"png":{"type":"integer","minimum":0}}}}}},"completeness":{"type":"object","required":["complete"],"properties":{"complete":{"type":["boolean","null"],"description":"Loaded inventory matches the pinned Unicode inventory; null when unknown."}}},"notices":{"type":"array","items":{"type":"object","required":["id","license","notice"],"properties":{"id":{"type":"string"},"license":{"type":"string"},"notice":{"type":"string"}}}}}},"localization":{"type":"object","required":["requested_locale","resolved_locale","translated_names","translated_keywords","fallback_names","fallback_keywords"],"properties":{"requested_locale":{"type":["string","null"]},"resolved_locale":{"type":["string","null"]},"translated_names":{"type":"integer","minimum":0},"translated_keywords":{"type":"integer","minimum":0},"fallback_names":{"type":"integer","minimum":0},"fallback_keywords":{"type":"integer","minimum":0}}},"total":{"type":"integer","minimum":0},"emojis":{"type":"array","items":{"type":"object","required":["emoji","name","shortcodes","category","version","keywords","subcategory"],"properties":{"emoji":{"type":"string"},"name":{"type":["string","null"]},"shortcodes":{"type":"array","items":{"type":"string"}},"category":{"type":["string","null"]},"version":{"type":["string","null"]},"keywords":{"type":"array","items":{"type":"string"}},"subcategory":{"type":["string","null"]},"base":{"type":"string"},"variants":{"type":"array","items":{"type":"object","required":["emoji","tones"],"properties":{"emoji":{"type":"string"},"tones":{"type":"array","items":{"type":"string"}}}}}}}},"scope":{"type":"object","required":["filters","complete_inventory"],"properties":{"filters":{"type":"object","additionalProperties":true},"complete_inventory":{"type":"boolean"}}},"forms":{"type":"object","additionalProperties":{"type":"string"}},"legacy":{"type":"object","additionalProperties":{"type":"string"}},"shortcodes":{"type":"object","properties":{"cldr":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"github":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"slack":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"discord":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"search":{"type":"object","required":["native","localized_keywords"],"properties":{"localized_keywords":{"type":"array","items":{"type":"string"},"description":"Returned glyphs whose keyword arrays have an actual translation. Optional and absent from native downloads."},"native":{"type":"object","additionalProperties":{"type":"object","required":["name","keywords","order"],"properties":{"name":{"type":["string","null"]},"keywords":{"type":"array","items":{"type":"string"}},"order":{"type":["integer","null"]}}}}}}}}}}},"304":{"description":"The selected representation is unchanged. No response body.","headers":{"ETag":{"description":"Validator for the selected payload. Identity responses use its strong SHA-256 tag; compression-capable responses use a weak tag across content codings. Language and filters affect the payload validator.","schema":{"type":"string"}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/emoji/convert":{"post":{"operationId":"emoji_convert","tags":["Emoji"],"summary":"Convert text with an explicit shortcode preset","description":"Converted text plus unresolved tokens. Surrounding and unresolved input stays literal. Positions use original UTF-16 offsets with exclusive end. Submitted text stays in the private POST body. Full field reference: https://parseapi.com/docs/emoji","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"direction","in":"query","required":true,"description":"Choose encoding or decoding.","schema":{"type":"string","enum":["to_emoji","to_shortcodes"]}},{"name":"shortcode_source","in":"query","required":true,"description":"Use one explicitly named preset.","schema":{"type":"string","enum":["cldr","github","slack","discord"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["text"],"additionalProperties":false,"properties":{"text":{"type":"string","maxLength":16000}}}}}},"responses":{"200":{"description":"Success (shape and representation vary by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","required":["text","unresolved"],"properties":{"text":{"type":"string"},"unresolved":{"type":"array","items":{"type":"object","required":["start","end","reason"],"properties":{"emoji":{"type":"string"},"shortcode":{"type":"string"},"start":{"type":"integer","minimum":0},"end":{"type":"integer","minimum":1},"reason":{"type":"string","enum":["unknown","ambiguous","unavailable"]}}}}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/emoji/parse":{"post":{"operationId":"emoji_parse","tags":["Emoji"],"summary":"Find complete emoji sequences in text","description":"Groups unique emoji in first-appearance order. Each positions array contains every occurrence using UTF-16 offsets with an exclusive end. Submitted text stays in the body. Unsupported graphemes are omitted as a whole. Full field reference: https://parseapi.com/docs/emoji","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"deep","in":"query","required":false,"description":"Unicode detail, keywords, sourced shortcode presets, complete skin-tone variants and licensed artwork links. Included automatically on paid plans in API 2.2. Existing accounts retain their current profile access.","schema":{"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["text"],"additionalProperties":false,"properties":{"text":{"type":"string","maxLength":16000}}}}}},"responses":{"200":{"description":"Success (shape and representation vary by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","required":["emojis"],"properties":{"emojis":{"type":"array","items":{"type":"object","required":["emoji","name","shortcodes","category","positions"],"properties":{"emoji":{"type":"string"},"name":{"type":["string","null"]},"shortcodes":{"type":"array","items":{"type":"string"}},"category":{"type":["string","null"]},"positions":{"type":"array","items":{"type":"object","required":["start","end"],"properties":{"start":{"type":"integer","minimum":0},"end":{"type":"integer","minimum":1}}}},"codepoints":{"type":"array","items":{"type":"string"}},"hex":{"type":["string","null"]},"status":{"type":["string","null"]},"version":{"type":["string","null"]},"keywords":{"type":"array","items":{"type":"string"}},"skins":{"type":"array","items":{"type":"object","required":["emoji","tone","unicode","hex"],"properties":{"emoji":{"type":"string"},"tone":{"type":"string"},"unicode":{"type":["string","null"]},"hex":{"type":["string","null"]}}}},"subcategory":{"type":["string","null"]},"base":{"type":"string"},"variants":{"type":"array","items":{"type":"object","required":["emoji","tones"],"properties":{"emoji":{"type":"string"},"tones":{"type":"array","items":{"type":"string"}}}}},"artwork":{"type":"object","additionalProperties":{"type":"object","properties":{"svg":{"type":"string","format":"uri"},"png":{"type":"object","propertyNames":{"pattern":"^[1-9][0-9]*$"},"additionalProperties":{"type":"string","format":"uri"}},"license":{"type":"string"},"license_url":{"type":"string","format":"uri"},"attribution":{"type":"string"}}}}}}}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/holiday/{country}/workdays":{"get":{"operationId":"holiday_workdays","tags":["Holiday"],"summary":"Count working dates under an explicit schedule","description":"API 2.2.0. Both from and to are inclusive, with at most 366 days. Supply the weekend policy explicitly and a region when the calendar contains regional holidays. Portugal preserves its national statutory baseline when region is omitted; region=20 includes Azores and region=30 includes Madeira. Applicable public holidays close dates; observances are ignored. Caller-provided working_dates and closed_dates override the selected policy. Official profiles are opt-in and limited to their stated country, year and scope. Refuses unavailable years (404), unverified evidence and relevant unresolved calendar dates (503). Uruguay includes designated working holidays and returns 503 until a reviewed closure policy is available. Does not infer country weekends, employer closures, or employment entitlement. Full field reference: https://parseapi.com/docs/holiday","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"country","in":"path","required":true,"description":"ISO 3166-1 alpha-2 country code","schema":{"type":"string","pattern":"^[A-Za-z]{2}$","example":"AU"}},{"name":"from","in":"query","required":true,"description":"First date, included in the result.","schema":{"type":"string","format":"date","example":"2027-01-01"}},{"name":"to","in":"query","required":true,"description":"Last date, included in the result. Must be on or after from and at most 365 days later.","schema":{"type":"string","format":"date","example":"2027-01-31"}},{"name":"region","in":"query","required":false,"description":"Reviewed subdivision suffix or matching full code. Required for regional calendars except Portugal and the US: omit for Portugal national holidays or US federal employee holidays. PT-20 selects Azores; PT-30 Madeira. Reviewed US states select their independent employee calendar and edition.","schema":{"type":"string","pattern":"^(?:[A-Za-z]{2}-)?[A-Za-z0-9]{1,6}$","example":"AU-NSW"}},{"name":"weekend","in":"query","required":true,"description":"Explicit comma-separated weekday digits: 0 is Sunday and 6 is Saturday. Use none for no weekend days. No country default is supplied.","schema":{"type":"string","pattern":"^(?:none|[0-6](?:,[0-6])*)$","example":"0,6"}},{"name":"working_dates","in":"query","required":false,"description":"Up to 50 comma-separated YYYY-MM-DD dates within the requested interval to treat as working.","schema":{"type":"string","example":"2027-01-02"}},{"name":"closed_dates","in":"query","required":false,"description":"Up to 50 comma-separated YYYY-MM-DD dates within the requested interval to treat as closed. A date cannot appear in both override lists.","schema":{"type":"string","example":"2027-01-04"}},{"name":"work_profile","in":"query","required":false,"description":"Explicit official profile: tw-government-office for TW2027 government administrative offices (published per-date status replaces the supplied weekend), cn-national-adjustments for CN2026 national breaks/make-up workdays, ru-five-day-adjustments for RU2027 five-day national adjustments, or by-five-day-adjustments for BY2027 prescribed five-day adjustments (CN/RU/BY require weekend=0,6). RU2027 and BY2027 scheduling require their profiles; missing selection returns 400. BY2027 makes May 8 working and May 10 a rest day, excluding employer alternative Saturdays, six-day and shift schedules. Every requested year must have a matching profile. No default; wrong country/year/weekend 400, changed bound calendar edition or scope 503. Caller date overrides take precedence.","schema":{"type":"string","enum":["tw-government-office","cn-national-adjustments","ru-five-day-adjustments","by-five-day-adjustments"]}},{"name":"deep","in":"query","required":false,"description":"Add the explanation for each considered civil date in days. Omitted by default.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","required":["country","from","to","region","policy","workdays","calendars"],"properties":{"country":{"type":"string"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"region":{"type":["string","null"]},"policy":{"type":"object","required":["weekend"],"properties":{"weekend":{"type":"array","uniqueItems":true,"items":{"type":"integer","minimum":0,"maximum":6}},"working_dates":{"type":"array","minItems":1,"items":{"type":"string","format":"date"}},"closed_dates":{"type":"array","minItems":1,"items":{"type":"string","format":"date"}},"work_profile":{"type":"object","required":["id","scope","coverage","editions"],"properties":{"id":{"type":"string","enum":["tw-government-office","cn-national-adjustments","ru-five-day-adjustments","by-five-day-adjustments"]},"scope":{"type":"string"},"coverage":{"type":"string","enum":["full_date_schedule","national_adjustments"]},"editions":{"type":"array","items":{"type":"object","required":["year","edition"],"properties":{"year":{"type":"integer"},"edition":{"type":"string","pattern":"^[a-f0-9]{64}$"},"verification":{"type":"string","const":"unverified","description":"Present when annual date review is unknown."}}}}},"additionalProperties":true}},"additionalProperties":true},"workdays":{"type":"integer","minimum":0,"maximum":366},"calendars":{"type":"array","minItems":1,"maxItems":2,"items":{"type":"object","required":["year","scope","completeness"],"properties":{"year":{"type":"integer"},"scope":{"type":"string"},"completeness":{"type":"string","enum":["reviewed_scope","partial"]},"verification":{"type":"string","const":"unverified","description":"Present when annual date review is unknown."},"pending":{"type":"array","items":{"type":"object","required":["name","reason"],"properties":{"name":{"type":"string"},"reason":{"type":"string"},"regions":{"type":"array","items":{"type":"string"}}}}}},"additionalProperties":true}},"days":{"type":"array","minItems":1,"maxItems":366,"items":{"type":"object","required":["date","working","reason"],"properties":{"date":{"type":"string","format":"date"},"working":{"type":"boolean"},"reason":{"type":"string","enum":["working_override","closure_override","public_holiday","weekend","working_day","official_working_day","official_rest_day","official_holiday_break","official_makeup_workday"]}},"additionalProperties":true}}},"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/holiday/{country}":{"get":{"operationId":"holiday","tags":["Holiday"],"summary":"Holidays by year, month, or day","description":"Returns a holidays array with all matching public holidays and observances, including multiple names on one date. A covered empty period returns 200 with holidays: []. Unavailable years return 404 with the available range. Available dates come from official publications or finite independently reviewed current rules, without claiming a future annual publication. Invalid dates return 400. A pending partial scope returns 503 rather than a silently incomplete collection; use /calendar for its confirmed dates and qualifications. This is the current collection contract. Full field reference: https://parseapi.com/docs/holiday","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"country","in":"path","required":true,"description":"ISO 3166-1 alpha-2 country code","schema":{"type":"string","pattern":"^[A-Za-z]{2}$","example":"US"}},{"name":"type","in":"query","required":false,"description":"Select public or observance. Omit to retain both categories and the existing public-first single-date choice. A covered category miss returns an empty array or holiday: null; a missing calendar remains 404. Unknown or repeated selectors return 400. Frozen 1.0.0 remains unchanged.","schema":{"type":"string","enum":["public","observance"]}},{"name":"year","in":"query","required":false,"description":"Four-digit available year; defaults to the current UTC year. Must match a path year when supplied.","schema":{"type":"integer","minimum":1,"maximum":9999,"example":2026}},{"name":"month","in":"query","required":false,"description":"Collection month. Must match a path month when supplied.","schema":{"type":"integer","minimum":1,"maximum":12,"example":12}},{"name":"day","in":"query","required":false,"description":"Collection day. Requires month and a real calendar date.","schema":{"type":"integer","minimum":1,"maximum":31,"example":25}},{"name":"region","in":"query","required":false,"description":"Reviewed subdivision suffix such as NSW or matching full code AU-NSW. Includes nationwide plus matching regional dates outside the US. Reviewed US states select their independent employee calendar, plus current countrywide observances when requested. Case-insensitive; unsupported or wrong-country regions return 400.","schema":{"type":"string","pattern":"^(?:[A-Za-z]{2}-)?[A-Za-z0-9]{1,6}$","example":"AU-NSW"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"string"},"year":{"type":"integer"},"holidays":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"name":{"type":"string"},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":"string","enum":["public","observance"]},"regions":{"type":["array","null"],"items":{"type":"string"}},"substitute":{"type":"boolean"}},"required":["date","name","name_local","type","regions","substitute"],"additionalProperties":true}},"month":{"type":"integer","minimum":1,"maximum":12},"day":{"type":"integer","minimum":1,"maximum":31}},"required":["country","year","holidays"],"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/holiday/{country}/{date}":{"get":{"operationId":"holiday_date","tags":["Holiday"],"summary":"Year or month collection, or one date","description":"YYYY and YYYY-MM are collection aliases, for example /holiday/US/2026 and /holiday/US/2026-12. Full YYYY-MM-DD dates retain the holiday object or null response, with public holidays taking priority. Query day filters on /holiday/{country} return every record on that date. Query filters can narrow a year or month path. Conflicting path/query values and invalid calendar dates return 400. Covered empty collections return 200 with holidays: [], and uncovered countries or unavailable years return 404. Period aliases are available on API 2.2.0. Unresolved partial scopes return 503 for a complete collection or a negative date answer; confirmed listed dates still return 200. Use /calendar to inspect qualifications. Frozen 1.0.0 retains the full-date route. Full field reference: https://parseapi.com/docs/holiday","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"country","in":"path","required":true,"description":"ISO 3166-1 alpha-2 country code","schema":{"type":"string","pattern":"^[A-Za-z]{2}$","example":"US"}},{"name":"date","in":"path","required":true,"description":"YYYY, YYYY-MM, or YYYY-MM-DD. Path months and days require two digits. Full dates must be real calendar dates.","schema":{"type":"string","pattern":"^\\d{4}(?:-\\d{2}){0,2}$","example":"2026-12-25"}},{"name":"type","in":"query","required":false,"description":"Select public or observance. Omit to retain both categories and the existing public-first single-date choice. A covered category miss returns an empty array or holiday: null; a missing calendar remains 404. Unknown or repeated selectors return 400. Frozen 1.0.0 remains unchanged.","schema":{"type":"string","enum":["public","observance"]}},{"name":"year","in":"query","required":false,"description":"Four-digit available year; defaults to the current UTC year. Must match a path year when supplied.","schema":{"type":"integer","minimum":1,"maximum":9999,"example":2026}},{"name":"month","in":"query","required":false,"description":"Collection month. Must match a path month when supplied.","schema":{"type":"integer","minimum":1,"maximum":12,"example":12}},{"name":"day","in":"query","required":false,"description":"Collection day. Requires month and a real calendar date.","schema":{"type":"integer","minimum":1,"maximum":31,"example":25}},{"name":"region","in":"query","required":false,"description":"Reviewed subdivision suffix such as NSW or matching full code AU-NSW. Includes nationwide plus matching regional dates outside the US. Reviewed US states select their independent employee calendar, plus current countrywide observances when requested. Case-insensitive; unsupported or wrong-country regions return 400.","schema":{"type":"string","pattern":"^(?:[A-Za-z]{2}-)?[A-Za-z0-9]{1,6}$","example":"AU-NSW"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"country":{"type":"string"},"year":{"type":"integer"},"holidays":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"name":{"type":"string"},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":"string","enum":["public","observance"]},"regions":{"type":["array","null"],"items":{"type":"string"}},"substitute":{"type":"boolean"}},"required":["date","name","name_local","type","regions","substitute"],"additionalProperties":true}},"month":{"type":"integer","minimum":1,"maximum":12},"day":{"type":"integer","minimum":1,"maximum":31}},"required":["country","year","holidays"],"additionalProperties":true},{"type":"object","properties":{"country":{"type":"string"},"date":{"type":"string","format":"date"},"holiday":{"type":["object","null"],"properties":{"date":{"type":"string","format":"date"},"name":{"type":"string"},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":"string","enum":["public","observance"]},"regions":{"type":["array","null"],"items":{"type":"string"}},"substitute":{"type":"boolean"}},"required":["date","name","name_local","type","regions","substitute"],"additionalProperties":true}},"required":["country","date","holiday"],"additionalProperties":true}]}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/city/id/{id}/children":{"get":{"operationId":"city_children","tags":["City"],"summary":"Reviewed City children","description":"Canonical reviewed relationships with partial coverage. An empty list does not establish the absence of a geographic relationship. Full field reference: https://parseapi.com/docs/city","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"id","in":"path","required":true,"description":"Stable returned City ID.","schema":{"type":"string","pattern":"^city_[a-z0-9]{12}$"}},{"name":"hierarchy","in":"query","required":false,"description":"Include the reviewed grain and immediate parent on each City. Unknown relationships are null.","schema":{"type":"boolean","const":true}},{"name":"deep","in":"query","required":false,"description":"Optional paid detail on each related City.","schema":{"type":"boolean"}},{"name":"limit","in":"query","required":false,"description":"Maximum records per page, 1–50.","schema":{"type":"integer","minimum":1,"maximum":50}},{"name":"cursor","in":"query","required":false,"description":"Opaque next_cursor from the previous response. Keep the original query options, including limit, unchanged. Invalid or changed cursors return 400; restart without a cursor. Verified revision-reader pages bind to their immutable edition; restart after an edition change. Legacy-reader pages follow the current catalog.","schema":{"type":"string","minLength":1,"maxLength":700}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"If-None-Match","in":"header","required":false,"description":"Validate a cached canonical response or relationship list. Matching validators return 304 without a body; ordinary request billing and rate limits still apply.","schema":{"type":"string"}},{"name":"romanized","in":"query","required":false,"description":"Include reviewed official romanized name_romanized and romanization_language. Missing or conflicting forms remain null; no ASCII-folding substitute. Available reviewed forms currently cover 20 Japanese whole-city aliases.","schema":{"type":"boolean","const":true}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"ETag":{"description":"Validator for the selected City representation and serving edition. Conditional HTTP reads can return 304. Ordinary pooled request billing and rate limits still apply.","schema":{"type":"string"}},"Cache-Control":{"description":"private, no-cache: retain a cached body but validate before reuse.","schema":{"type":"string","const":"private, no-cache"}},"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","required":["object","data","next_cursor","city_id","relationship","coverage"],"properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","latitude","longitude","timezone","id","object"],"properties":{"object":{"type":"string","const":"city"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"match":{"type":"object","required":["type","value","language"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"language":{"type":["string","null"]}}},"id":{"type":"string","pattern":"^city_[a-z0-9]{12}$"}},"additionalProperties":true}},"next_cursor":{"type":["string","null"],"description":"Opaque cursor for another page, or null at the end. Search and named nearby include this only with page=true or cursor."},"city_id":{"type":"string"},"relationship":{"type":"string","enum":["children","ancestors","siblings"]},"coverage":{"type":"string","const":"partial"},"parent_id":{"type":["string","null"]}},"additionalProperties":true}}}},"304":{"description":"The selected canonical or catalog metadata representation is unchanged. No response body; ordinary request billing and rate limits apply.","headers":{"ETag":{"description":"Validator for the selected City representation and serving edition. Conditional HTTP reads can return 304. Ordinary pooled request billing and rate limits still apply.","schema":{"type":"string"}},"Cache-Control":{"description":"private, no-cache: retain a cached body but validate before reuse.","schema":{"type":"string","const":"private, no-cache"}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/city/id/{id}/ancestors":{"get":{"operationId":"city_ancestors","tags":["City"],"summary":"Reviewed City ancestors","description":"Canonical reviewed relationships with partial coverage. An empty list does not establish the absence of a geographic relationship. Full field reference: https://parseapi.com/docs/city","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"id","in":"path","required":true,"description":"Stable returned City ID.","schema":{"type":"string","pattern":"^city_[a-z0-9]{12}$"}},{"name":"hierarchy","in":"query","required":false,"description":"Include the reviewed grain and immediate parent on each City. Unknown relationships are null.","schema":{"type":"boolean","const":true}},{"name":"deep","in":"query","required":false,"description":"Optional paid detail on each related City.","schema":{"type":"boolean"}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"If-None-Match","in":"header","required":false,"description":"Validate a cached canonical response or relationship list. Matching validators return 304 without a body; ordinary request billing and rate limits still apply.","schema":{"type":"string"}},{"name":"romanized","in":"query","required":false,"description":"Include reviewed official romanized name_romanized and romanization_language. Missing or conflicting forms remain null; no ASCII-folding substitute. Available reviewed forms currently cover 20 Japanese whole-city aliases.","schema":{"type":"boolean","const":true}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"ETag":{"description":"Validator for the selected City representation and serving edition. Conditional HTTP reads can return 304. Ordinary pooled request billing and rate limits still apply.","schema":{"type":"string"}},"Cache-Control":{"description":"private, no-cache: retain a cached body but validate before reuse.","schema":{"type":"string","const":"private, no-cache"}},"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","required":["object","data","next_cursor","city_id","relationship","coverage"],"properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","latitude","longitude","timezone","id","object"],"properties":{"object":{"type":"string","const":"city"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"match":{"type":"object","required":["type","value","language"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"language":{"type":["string","null"]}}},"id":{"type":"string","pattern":"^city_[a-z0-9]{12}$"}},"additionalProperties":true}},"next_cursor":{"type":["string","null"],"description":"Opaque cursor for another page, or null at the end. Search and named nearby include this only with page=true or cursor."},"city_id":{"type":"string"},"relationship":{"type":"string","enum":["children","ancestors","siblings"]},"coverage":{"type":"string","const":"partial"},"parent_id":{"type":["string","null"]}},"additionalProperties":true}}}},"304":{"description":"The selected canonical or catalog metadata representation is unchanged. No response body; ordinary request billing and rate limits apply.","headers":{"ETag":{"description":"Validator for the selected City representation and serving edition. Conditional HTTP reads can return 304. Ordinary pooled request billing and rate limits still apply.","schema":{"type":"string"}},"Cache-Control":{"description":"private, no-cache: retain a cached body but validate before reuse.","schema":{"type":"string","const":"private, no-cache"}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/city/id/{id}/siblings":{"get":{"operationId":"city_siblings","tags":["City"],"summary":"Reviewed City siblings","description":"Canonical reviewed relationships with partial coverage. An empty list does not establish the absence of a geographic relationship. Full field reference: https://parseapi.com/docs/city","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"id","in":"path","required":true,"description":"Stable returned City ID.","schema":{"type":"string","pattern":"^city_[a-z0-9]{12}$"}},{"name":"hierarchy","in":"query","required":false,"description":"Include the reviewed grain and immediate parent on each City. Unknown relationships are null.","schema":{"type":"boolean","const":true}},{"name":"deep","in":"query","required":false,"description":"Optional paid detail on each related City.","schema":{"type":"boolean"}},{"name":"limit","in":"query","required":false,"description":"Maximum records per page, 1–50.","schema":{"type":"integer","minimum":1,"maximum":50}},{"name":"cursor","in":"query","required":false,"description":"Opaque next_cursor from the previous response. Keep the original query options, including limit, unchanged. Invalid or changed cursors return 400; restart without a cursor. Verified revision-reader pages bind to their immutable edition; restart after an edition change. Legacy-reader pages follow the current catalog.","schema":{"type":"string","minLength":1,"maxLength":700}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"If-None-Match","in":"header","required":false,"description":"Validate a cached canonical response or relationship list. Matching validators return 304 without a body; ordinary request billing and rate limits still apply.","schema":{"type":"string"}},{"name":"romanized","in":"query","required":false,"description":"Include reviewed official romanized name_romanized and romanization_language. Missing or conflicting forms remain null; no ASCII-folding substitute. Available reviewed forms currently cover 20 Japanese whole-city aliases.","schema":{"type":"boolean","const":true}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"ETag":{"description":"Validator for the selected City representation and serving edition. Conditional HTTP reads can return 304. Ordinary pooled request billing and rate limits still apply.","schema":{"type":"string"}},"Cache-Control":{"description":"private, no-cache: retain a cached body but validate before reuse.","schema":{"type":"string","const":"private, no-cache"}},"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"type":"object","required":["object","data","next_cursor","city_id","relationship","coverage"],"properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","latitude","longitude","timezone","id","object"],"properties":{"object":{"type":"string","const":"city"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"match":{"type":"object","required":["type","value","language"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"language":{"type":["string","null"]}}},"id":{"type":"string","pattern":"^city_[a-z0-9]{12}$"}},"additionalProperties":true}},"next_cursor":{"type":["string","null"],"description":"Opaque cursor for another page, or null at the end. Search and named nearby include this only with page=true or cursor."},"city_id":{"type":"string"},"relationship":{"type":"string","enum":["children","ancestors","siblings"]},"coverage":{"type":"string","const":"partial"},"parent_id":{"type":["string","null"]}},"additionalProperties":true}}}},"304":{"description":"The selected canonical or catalog metadata representation is unchanged. No response body; ordinary request billing and rate limits apply.","headers":{"ETag":{"description":"Validator for the selected City representation and serving edition. Conditional HTTP reads can return 304. Ordinary pooled request billing and rate limits still apply.","schema":{"type":"string"}},"Cache-Control":{"description":"private, no-cache: retain a cached body but validate before reuse.","schema":{"type":"string","const":"private, no-cache"}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/city/search":{"get":{"operationId":"city_search_explicit","tags":["City"],"summary":"Explicit City name search","description":"With q, returns a canonical data list. Supports exact, prefix and explicit fuzzy matching. Without q, preserves the existing City name lookup. Full field reference: https://parseapi.com/docs/city","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"q","in":"query","required":true,"description":"City name query, at least two characters.","schema":{"type":"string","minLength":2,"maxLength":500}},{"name":"country","in":"query","required":false,"description":"ISO2 country scope.","schema":{"type":"string","pattern":"^[A-Za-z]{2}$"}},{"name":"state","in":"query","required":false,"description":"State code such as FL or US-FL. Get codes from /country/{country}/states. State names return 400. A country prefix must match the country filter.","schema":{"type":"string","minLength":1,"maxLength":6,"pattern":"^(?:[A-Za-z]{2}-)?[A-Za-z0-9]{1,3}$","example":"FL"}},{"name":"limit","in":"query","required":false,"description":"Maximum results, 1–50.","schema":{"type":"integer","minimum":1,"maximum":50}},{"name":"deep","in":"query","required":false,"description":"Optional paid detail on each City.","schema":{"type":"boolean"}},{"name":"match","in":"query","required":false,"description":"Search name matching. Fuzzy is explicit and returns suggestion evidence; no implicit spelling correction in exact lookup.","schema":{"type":"string","enum":["exact","prefix","fuzzy"],"default":"prefix"}},{"name":"max_distance","in":"query","required":false,"description":"Maximum edit distance for explicit fuzzy matching.","schema":{"type":"integer","enum":[1,2]}},{"name":"type","in":"query","required":false,"description":"Filter the recorded place type, such as city or ward.","schema":{"type":"string","minLength":1,"maxLength":60}},{"name":"grain","in":"query","required":false,"description":"Filter a reviewed geographic layer. Unreviewed records do not match.","schema":{"type":"string","enum":["municipality","subdivision","locality","metropolitan_area"]}},{"name":"hierarchy","in":"query","required":false,"description":"Include the reviewed grain and immediate parent on each City. Unknown relationships are null.","schema":{"type":"boolean","const":true}},{"name":"aliases","in":"query","required":false,"description":"Also match reviewed official name forms. Applies to name lookup and search, without spelling correction.","schema":{"type":"boolean","const":true}},{"name":"format","in":"query","required":false,"description":"Default canonical list, or format=geojson for stored place centers.","schema":{"type":"string","enum":["geojson"]}},{"name":"countries","in":"query","required":false,"description":"Comma-separated ISO2 country set; at most 50 distinct codes. Collection results must belong to this set.","schema":{"type":"string","minLength":2,"maxLength":149,"example":"JP,AT"}},{"name":"exclude_countries","in":"query","required":false,"description":"Comma-separated ISO2 countries excluded from collection results.","schema":{"type":"string","minLength":2,"maxLength":149}},{"name":"cursor","in":"query","required":false,"description":"Opaque next_cursor from the previous response. Keep the original query options, including limit, unchanged. Invalid or changed cursors return 400; restart without a cursor. Verified revision-reader pages bind to their immutable edition; restart after an edition change. Legacy-reader pages follow the current catalog.","schema":{"type":"string","minLength":1,"maxLength":700}},{"name":"pretty","in":"query","required":false,"description":"Indent the JSON response for readability.","schema":{"type":"boolean","const":true}},{"name":"lang","in":"query","required":false,"description":"Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.","schema":{"type":"string","minLength":2,"maxLength":64,"example":"fr","x-supported-locales":["en","ar","ca","hr","cs","da","nl","fi","fr","de","el","he","hi","hu","id","it","ja","ko","ms","nb","pl","pt","ro","ru","zh-Hans","sk","es","sv","th","zh-Hant","tr","uk","vi"]}},{"name":"If-None-Match","in":"header","required":false,"description":"Validate a cached canonical response or relationship list. Matching validators return 304 without a body; ordinary request billing and rate limits still apply.","schema":{"type":"string"}},{"name":"romanized","in":"query","required":false,"description":"Include reviewed official romanized name_romanized and romanization_language. Missing or conflicting forms remain null; no ASCII-folding substitute. Available reviewed forms currently cover 20 Japanese whole-city aliases.","schema":{"type":"boolean","const":true}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"ETag":{"description":"Validator for the selected City representation and serving edition. Conditional HTTP reads can return 304. Ordinary pooled request billing and rate limits still apply.","schema":{"type":"string"}},"Cache-Control":{"description":"private, no-cache: retain a cached body but validate before reuse.","schema":{"type":"string","const":"private, no-cache"}},"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Language":{"description":"Languages used in selected display fields, including known English fallbacks. Unchanged native or source text does not imply a language.","schema":{"type":"string","example":"fr"}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","required":["object","data","next_cursor"],"properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","latitude","longitude","timezone","id","object"],"properties":{"object":{"type":"string","const":"city"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"match":{"type":"object","required":["type","value","language"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"language":{"type":["string","null"]}}},"id":{"type":"string","pattern":"^city_[a-z0-9]{12}$"}},"additionalProperties":true}},"next_cursor":{"type":["string","null"],"description":"Opaque cursor for another page, or null at the end. Search and named nearby include this only with page=true or cursor."}},"additionalProperties":true},{"type":"object","required":["type","features","next_cursor"],"properties":{"type":{"type":"string","const":"FeatureCollection"},"features":{"type":"array","items":{"type":"object","required":["type","id","geometry","properties"],"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^city_[a-z0-9]{12}$"},"geometry":{"oneOf":[{"type":"null"},{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","const":"Point"},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number"},"description":"Longitude, latitude of the stored center."}}}]},"properties":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","timezone"],"properties":{"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"match":{"type":"object","required":["type","value","language"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"language":{"type":["string","null"]}}}},"additionalProperties":true}}}},"next_cursor":{"type":["string","null"],"description":"Opaque cursor for another page, or null at the end. Search and named nearby include this only with page=true or cursor."}},"additionalProperties":true}]}},"application/geo+json":{"schema":{"type":"object","required":["type","features","next_cursor"],"properties":{"type":{"type":"string","const":"FeatureCollection"},"features":{"type":"array","items":{"type":"object","required":["type","id","geometry","properties"],"properties":{"type":{"type":"string","const":"Feature"},"id":{"type":"string","pattern":"^city_[a-z0-9]{12}$"},"geometry":{"oneOf":[{"type":"null"},{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","const":"Point"},"coordinates":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number"},"description":"Longitude, latitude of the stored center."}}}]},"properties":{"type":"object","required":["name","name_local","type","state","state_name","county","county_name","country","country_name","timezone"],"properties":{"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":["string","null"]},"county":{"type":["string","null"]},"county_name":{"type":["string","null"]},"state":{"type":["string","null"]},"state_name":{"type":["string","null"]},"country":{"type":["string","null"]},"country_name":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null],"description":"Included with hierarchy=true; null when unreviewed."},"parent":{"type":["object","null"],"description":"Included with hierarchy=true; null when no reviewed immediate parent exists.","required":["id","name","name_local","country","state","type","grain"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"state":{"type":["string","null"]},"country":{"type":"string"},"type":{"type":["string","null"]},"grain":{"type":["string","null"],"enum":["municipality","subdivision","locality","metropolitan_area",null]}}},"name_romanized":{"type":["string","null"]},"romanization_language":{"type":["string","null"]},"timezone":{"type":["string","null"]},"distance":{"type":"number","description":"Distance from the query coordinates or named anchor, in kilometers."},"distance_mi":{"type":"number","description":"Distance from the same point, in miles."},"capital_of":{"type":["string","null"],"enum":["country","state",null]},"elevation":{"type":["integer","null"],"description":"Elevation in meters."},"elevation_ft":{"type":["integer","null"]},"population":{"type":["integer","null"]},"population_observed_on":{"type":"string","format":"date","description":"Exact date for a reviewed same-grain population observation. Omitted for legacy undated counts."},"population_basis":{"type":"string","description":"Published counting basis, such as registered_population or usual_residence_register."},"area":{"type":["number","null"],"description":"Total area in square kilometers."},"land_area":{"type":["number","null"]},"water_area":{"type":["number","null"]},"match":{"type":"object","required":["type","value","language"],"properties":{"type":{"type":"string"},"value":{"type":"string"},"language":{"type":["string","null"]}}}},"additionalProperties":true}}}},"next_cursor":{"type":["string","null"],"description":"Opaque cursor for another page, or null at the end. Search and named nearby include this only with page=true or cursor."}},"additionalProperties":true}}}},"304":{"description":"The selected canonical or catalog metadata representation is unchanged. No response body; ordinary request billing and rate limits apply.","headers":{"ETag":{"description":"Validator for the selected City representation and serving edition. Conditional HTTP reads can return 304. Ordinary pooled request billing and rate limits still apply.","schema":{"type":"string"}},"Cache-Control":{"description":"private, no-cache: retain a cached body but validate before reuse.","schema":{"type":"string","const":"private, no-cache"}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/city/id/{id}/distance/{other}":{"get":{"operationId":"city_distance","tags":["City"],"summary":"Great-circle distance between City centers","description":"Center-to-center kilometers and miles. Zero is known zero; null means unavailable coordinates. No routing or containment inference. Full field reference: https://parseapi.com/docs/city","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"id","in":"path","required":true,"description":"Stable returned City ID.","schema":{"type":"string","pattern":"^city_[a-z0-9]{12}$"}},{"name":"other","in":"path","required":true,"description":"Destination City ID.","schema":{"type":"string","pattern":"^city_[a-z0-9]{12}$"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","required":["object","from","to","distance","distance_mi","method"],"properties":{"object":{"type":"string","const":"city_distance"},"from":{"type":"string"},"to":{"type":"string"},"distance":{"type":["number","null"],"minimum":0,"description":"Great-circle kilometers between stored centers. Null when a center is unavailable."},"distance_mi":{"type":["number","null"],"minimum":0},"method":{"type":"string","const":"great_circle"}}}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/holiday/{country}/business-date":{"get":{"operationId":"holiday_business_date","tags":["Holiday"],"summary":"Move a civil date by a signed number of working dates","description":"API 2.2.0. Requires an explicit weekend and reviewed scope. Portugal uses its national statutory baseline without region; select region=20 or region=30 to include Azores or Madeira holidays. business_days is a signed integer from -366 through 366. Negative counts backward. The start is excluded unless include_start_date=true and that date is working. Zero returns the unchanged start after verifying its calendar. Stops within 732 calendar days of the start and loads every reached year. Missing years return 404, unverified evidence or relevant pending dates return 503, and invalid bounds return 400. Uruguay includes designated working holidays and returns 503 until a reviewed closure policy is available. Calendar forecasts are never used for deadlines. Full field reference: https://parseapi.com/docs/holiday","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"country","in":"path","required":true,"description":"ISO 3166-1 alpha-2 country code","schema":{"type":"string","pattern":"^[A-Za-z]{2}$","example":"AU"}},{"name":"start_date","in":"query","required":true,"description":"Real civil start date. The default excludes this date from the count.","schema":{"type":"string","format":"date","example":"2027-01-04"}},{"name":"business_days","in":"query","required":true,"description":"Signed integer offset. Use a negative value to count backward, or zero to retain the start.","schema":{"type":"integer","minimum":-366,"maximum":366,"example":-1}},{"name":"include_start_date","in":"query","required":false,"description":"Count the start as the first date only when it is working. The default excludes it. Zero always leaves the start unchanged.","schema":{"type":"boolean","default":false}},{"name":"region","in":"query","required":false,"description":"Reviewed subdivision suffix or matching full code. Required for regional calendars except Portugal and the US: omit for Portugal national holidays or US federal employee holidays. PT-20 selects Azores; PT-30 Madeira. Reviewed US states select their independent employee calendar and edition.","schema":{"type":"string","pattern":"^(?:[A-Za-z]{2}-)?[A-Za-z0-9]{1,6}$","example":"AU-NSW"}},{"name":"weekend","in":"query","required":true,"description":"Explicit comma-separated weekday digits: 0 is Sunday and 6 is Saturday. Use none for no weekend days. No country default is supplied.","schema":{"type":"string","pattern":"^(?:none|[0-6](?:,[0-6])*)$","example":"0,6"}},{"name":"working_dates","in":"query","required":false,"description":"Up to 50 comma-separated YYYY-MM-DD caller overrides in the selected direction, within 732 calendar days of start_date. A date cannot appear in both override lists.","schema":{"type":"string","example":"2027-01-02"}},{"name":"closed_dates","in":"query","required":false,"description":"Up to 50 comma-separated YYYY-MM-DD caller overrides in the selected direction, within 732 calendar days of start_date. A date cannot appear in both override lists.","schema":{"type":"string","example":"2027-01-04"}},{"name":"work_profile","in":"query","required":false,"description":"Explicit official profile: tw-government-office for TW2027 government administrative offices (published per-date status replaces the supplied weekend), cn-national-adjustments for CN2026 national breaks/make-up workdays, ru-five-day-adjustments for RU2027 five-day national adjustments, or by-five-day-adjustments for BY2027 prescribed five-day adjustments (CN/RU/BY require weekend=0,6). RU2027 and BY2027 scheduling require their profiles; missing selection returns 400. BY2027 makes May 8 working and May 10 a rest day, excluding employer alternative Saturdays, six-day and shift schedules. Every requested year must have a matching profile. No default; wrong country/year/weekend 400, changed bound calendar edition or scope 503. Caller date overrides take precedence.","schema":{"type":"string","enum":["tw-government-office","cn-national-adjustments","ru-five-day-adjustments","by-five-day-adjustments"]}},{"name":"deep","in":"query","required":false,"description":"Add the explanation for each considered civil date in days. Omitted by default.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","required":["country","start_date","business_days","date","region","policy","calendars"],"properties":{"country":{"type":"string"},"start_date":{"type":"string","format":"date"},"business_days":{"type":"integer","minimum":-366,"maximum":366},"date":{"type":"string","format":"date"},"region":{"type":["string","null"]},"policy":{"type":"object","required":["weekend","include_start_date"],"properties":{"weekend":{"type":"array","uniqueItems":true,"items":{"type":"integer","minimum":0,"maximum":6}},"working_dates":{"type":"array","minItems":1,"items":{"type":"string","format":"date"}},"closed_dates":{"type":"array","minItems":1,"items":{"type":"string","format":"date"}},"work_profile":{"type":"object","required":["id","scope","coverage","editions"],"properties":{"id":{"type":"string","enum":["tw-government-office","cn-national-adjustments","ru-five-day-adjustments","by-five-day-adjustments"]},"scope":{"type":"string"},"coverage":{"type":"string","enum":["full_date_schedule","national_adjustments"]},"editions":{"type":"array","items":{"type":"object","required":["year","edition"],"properties":{"year":{"type":"integer"},"edition":{"type":"string","pattern":"^[a-f0-9]{64}$"},"verification":{"type":"string","const":"unverified","description":"Present when annual date review is unknown."}}}}},"additionalProperties":true},"include_start_date":{"type":"boolean"}},"additionalProperties":true},"calendars":{"type":"array","minItems":1,"maxItems":4,"items":{"type":"object","required":["year","scope","completeness"],"properties":{"year":{"type":"integer"},"scope":{"type":"string"},"completeness":{"type":"string","enum":["reviewed_scope","partial"]},"verification":{"type":"string","const":"unverified","description":"Present when annual date review is unknown."},"pending":{"type":"array","items":{"type":"object","required":["name","reason"],"properties":{"name":{"type":"string"},"reason":{"type":"string"},"regions":{"type":"array","items":{"type":"string"}}}}}},"additionalProperties":true}},"days":{"type":"array","minItems":1,"maxItems":733,"items":{"type":"object","required":["date","working","reason","counted"],"properties":{"date":{"type":"string","format":"date"},"working":{"type":"boolean"},"reason":{"type":"string","enum":["working_override","closure_override","public_holiday","weekend","working_day","official_working_day","official_rest_day","official_holiday_break","official_makeup_workday"]},"counted":{"type":"boolean"}},"additionalProperties":true}}},"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/holiday/{country}/range":{"get":{"operationId":"holiday_range","tags":["Holiday"],"summary":"List every matching occasion across an explicit inclusive civil window","description":"API 2.2.0. Requires inclusive from and to, at most 731 civil dates and three annual calendars. Returns holidays in the ordinary six-field shape and compact calendars references for every reached year. Current defaults to public plus observance; type selects one category. Missing any required year returns 404 and unmatched evidence returns 503. No partial window or silent truncation. Retained scope and pending dates do not establish every employer’s closure schedule. Full field reference: https://parseapi.com/docs/holiday","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"country","in":"path","required":true,"description":"ISO 3166-1 alpha-2 country code","schema":{"type":"string","pattern":"^[A-Za-z]{2}$","example":"AU"}},{"name":"from","in":"query","required":true,"description":"Real inclusive civil start date, chosen by the caller.","schema":{"type":"string","format":"date","example":"2026-12-25"}},{"name":"to","in":"query","required":true,"description":"Real inclusive civil end date; at most 731 dates including both bounds.","schema":{"type":"string","format":"date","example":"2027-01-03"}},{"name":"type","in":"query","required":false,"description":"Current defaults to public plus observance. Select one category.","schema":{"type":"string","enum":["public","observance"]}},{"name":"region","in":"query","required":false,"description":"Nationwide plus matching regional rows outside the US. A reviewed US state selects its independent annual public calendar. Current countrywide observances are included when requested. The region must be represented in every reached annual public calendar; unsupported annual regional scope returns 400.","schema":{"type":"string","pattern":"^(?:[A-Za-z]{2}-)?[A-Za-z0-9]{1,6}$","example":"AU-NSW"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}}},"content":{"application/json":{"schema":{"type":"object","required":["country","from","to","region","holidays","calendars"],"properties":{"country":{"type":"string"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"region":{"type":["string","null"]},"holidays":{"type":"array","maxItems":30000,"items":{"type":"object","required":["date","name","name_local","type","regions","substitute"],"properties":{"date":{"type":"string","format":"date"},"name":{"type":"string"},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":"string","enum":["public","observance"]},"regions":{"type":["array","null"],"items":{"type":"string"}},"substitute":{"type":"boolean"}},"additionalProperties":true}},"calendars":{"type":"array","minItems":1,"maxItems":3,"items":{"type":"object","required":["year","scope","completeness"],"properties":{"year":{"type":"integer"},"scope":{"type":"string"},"completeness":{"type":"string","enum":["reviewed_scope","partial"]},"verification":{"type":"string","const":"unverified","description":"Present when annual date review is unknown."},"pending":{"type":"array","items":{"type":"object","required":["name","reason"],"properties":{"name":{"type":"string"},"reason":{"type":"string"},"regions":{"type":"array","items":{"type":"string"}}}}}},"additionalProperties":true}}},"additionalProperties":true}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/holiday/{country}/calendar":{"get":{"operationId":"holiday_calendar","tags":["Holiday"],"summary":"Read a reviewed public calendar or download its snapshot","description":"API 2.2.0. Requires explicit year and matching reviewed public records. JSON returns country, year, scope, completeness and a complete holidays array. Pending items and unknown annual date review remain explicit. deep=true adds known reviewed actual/observed relationships and their citations. JSON accepts region for an independent US state edition; other countries return the complete edition and reject JSON region filters. format=ics uses all-day events with exclusive next-date ends. Portugal defaults to national dates and the US to federal employee dates; other regional calendars require a region. format=csv preserves civil dates and can filter a reviewed region. Downloads retain scope, edition and annual date verification and return Content-Disposition. They are snapshots, not live subscriptions. Missing years/editions return 404; mismatched evidence returns 503. Full field reference: https://parseapi.com/docs/holiday","security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"country","in":"path","required":true,"description":"ISO 3166-1 alpha-2 country code","schema":{"type":"string","pattern":"^[A-Za-z]{2}$","example":"AU"}},{"name":"year","in":"query","required":true,"description":"Explicit four-digit year. Unavailable years remain 404.","schema":{"type":"integer","minimum":1,"maximum":9999,"example":2027}},{"name":"deep","in":"query","required":false,"description":"Add reviewed actual/observed relationships and their citations when known.","schema":{"type":"boolean"}},{"name":"format","in":"query","required":false,"description":"json returns the complete calendar resource. ics and csv download immutable snapshots, not live subscriptions.","schema":{"type":"string","enum":["json","ics","csv"],"default":"json"}},{"name":"region","in":"query","required":false,"description":"Selects an independent US state edition, including JSON; its edition pin requires the matching state. Other countries accept region for downloads only. Portugal ICS defaults to national dates and US ICS to federal employee dates. Other regional ICS requires a region. CSV can retain the full selected edition or filter a region.","schema":{"type":"string","pattern":"^(?:[A-Za-z]{2}-)?[A-Za-z0-9]{1,6}$","example":"AU-NSW"}}],"responses":{"200":{"description":"Success, minimal JSON object (shape varies by endpoint)","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"X-API-Version":{"description":"The exact response contract selected for this request.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"]}},"Content-Disposition":{"description":"Present on ICS/CSV downloads as an attachment filename including the country, year and selected region when supplied.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["country","year","scope","completeness","holidays"],"properties":{"country":{"type":"string"},"year":{"type":"integer"},"scope":{"type":"string"},"completeness":{"type":"string","enum":["reviewed_scope","partial"]},"verification":{"type":"string","const":"unverified","description":"Present when annual date review is unknown."},"pending":{"type":"array","items":{"type":"object","required":["name","reason"],"properties":{"name":{"type":"string"},"reason":{"type":"string"},"regions":{"type":"array","items":{"type":"string"}}}}},"holidays":{"type":"array","maxItems":10000,"items":{"type":"object","required":["date","name","name_local","type","regions","substitute"],"properties":{"date":{"type":"string","format":"date"},"name":{"type":"string"},"name_local":{"type":["string","null"],"description":"Native name, null when absent or exactly identical to the original source name. lang preserves this field, so it may equal the translated display name."},"type":{"type":"string","const":"public"},"regions":{"type":["array","null"],"items":{"type":"string"}},"substitute":{"type":"boolean"}},"additionalProperties":true}},"date_relationships":{"type":"array","minItems":1,"items":{"type":"object","required":["date","name","regions","actual_date","observed_date"],"properties":{"date":{"type":"string","format":"date"},"name":{"type":"string"},"regions":{"type":["array","null"],"items":{"type":"string"}},"actual_date":{"type":"string","format":"date"},"observed_date":{"type":"string","format":"date"}}}}},"additionalProperties":true}},"text/calendar":{"schema":{"type":"string","description":"RFC 5545 all-day snapshot with VALUE=DATE civil dates and exclusive DTEND. Distinct occasions have distinct event UIDs. Descriptions retain declared scope, completeness and pending reasons without fabricating events for undated occasions. No live subscription or timezone is inferred."}},"text/csv":{"schema":{"type":"string","description":"UTF-8 RFC 4180 rows with literal dates, ordinary holiday fields, reviewed actual/observed dates when known, calendar scope and edition. Pending uncertainty and annual date verification travel with records. Null facts remain empty cells; arrays remain quoted JSON."}}}},"400":{"description":"invalid_request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied or plan_required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"api_version_retired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited or quota_exceeded","headers":{"X-RateLimit-Limit":{"description":"Sustained requests per minute for your team","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Estimated requests available in the current window or token bucket","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets, or until full bucket recovery with no more calls when X-RateLimit-Burst is present. On a 429 use Retry-After for the next attempt.","schema":{"type":"integer"}},"X-RateLimit-Burst":{"description":"Optional token bucket capacity. When present, capacity replenishes continuously at X-RateLimit-Limit requests per minute.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"server_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/preflight":{"post":{"operationId":"preflight","summary":"Estimate a task","description":"Check permissions, advisory account capacity and maximum additional charges for up to 100000 lookups. Makes no lookups and reserves no units or money. budget_usd is optional and never enforced.","tags":["Agent tasks"],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["operations"],"properties":{"operations":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"object","additionalProperties":false,"required":["operation","count"],"properties":{"operation":{"type":"string","enum":["email","carrier","caller","hlr","domain","dns","mx","country","ip","phone","postal"]},"count":{"type":"integer","minimum":1,"maximum":100000},"deep":{"type":"boolean","default":false}}}},"budget_usd":{"type":"string","pattern":"^(?:0|[1-9]\\d{0,11})(?:\\.\\d{1,2})?$","example":"1.00"}}}}}},"responses":{"200":{"description":"Success","headers":{"X-API-Version":{"description":"Exact selected response contract.","schema":{"type":"string","enum":["2.0.0"]}}},"content":{"application/json":{"schema":{"type":"object","required":["estimate_only","permitted","cost","capacity"],"properties":{"estimate_only":{"const":true},"permitted":{"type":"boolean"},"cost":{"type":"object","additionalProperties":true},"capacity":{"type":"object","additionalProperties":true}},"additionalProperties":true}}}},"400":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/task":{"post":{"operationId":"task_create","summary":"Authorize a bounded task","description":"Create a 24-hour task for at most 1000 lookups, bound to this secret key, with an enforced additional-charge USD budget up to 1000000. No lookup or account-unit reservation occurs at creation.","tags":["Agent tasks"],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID per intended request. Reuse the same ID with identical inputs on retries. Keep lookup values out of this header.","schema":{"type":"string","pattern":"^[A-Za-z0-9._:-]{1,128}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["operations","budget_usd"],"properties":{"operations":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"object","additionalProperties":false,"required":["operation","count"],"properties":{"operation":{"type":"string","enum":["email","carrier","caller","hlr","domain","dns","mx","country","ip","phone","postal"]},"count":{"type":"integer","minimum":1,"maximum":1000},"deep":{"type":"boolean","default":false}}},"description":"At most 1000 lookups in total across all rows."},"budget_usd":{"type":"string","pattern":"^(?:(?:0|[1-9]\\d{0,5})(?:\\.\\d{1,2})?|1000000(?:\\.0{1,2})?)$","example":"1.00","description":"Maximum additional charges, at most 1000000 USD. Only task lookups obey this limit."}}}}}},"responses":{"200":{"description":"Success","headers":{"X-API-Version":{"description":"Exact selected response contract.","schema":{"type":"string","enum":["2.0.0"]}}},"content":{"application/json":{"schema":{"type":"object","required":["id","status","api_version","created_at","expires_at","result_expires_at","budget","operations"],"properties":{"id":{"type":"string","pattern":"^task_[a-f0-9]{40}$"},"status":{"type":"string","enum":["active","cancelled","expired"]},"api_version":{"type":"string","const":"2.0.0"},"created_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"result_expires_at":{"type":"string","format":"date-time"},"budget":{"type":"object","required":["currency","enforced","maximum_usd","spent_usd","reserved_usd","remaining_usd"],"properties":{"currency":{"type":"string","const":"USD"},"enforced":{"type":"boolean","const":true},"maximum_usd":{"type":"string","pattern":"^\\d+\\.\\d{4}$"},"spent_usd":{"type":"string","pattern":"^\\d+\\.\\d{4}$"},"reserved_usd":{"type":"string","pattern":"^\\d+\\.\\d{4}$"},"remaining_usd":{"type":"string","pattern":"^\\d+\\.\\d{4}$"}}},"operations":{"type":"array","items":{"type":"object","required":["operation","deep","count","allocated","completed","remaining"],"properties":{"operation":{"type":"string","enum":["email","carrier","caller","hlr","domain","dns","mx","country","ip","phone","postal"]},"deep":{"type":"boolean"},"count":{"type":"integer","minimum":1,"maximum":1000},"allocated":{"type":"integer","minimum":0},"completed":{"type":"integer","minimum":0},"remaining":{"type":"integer","minimum":0}}}}},"additionalProperties":true}}}},"400":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/task/{id}":{"get":{"operationId":"task_status","summary":"Read task budget and progress","description":"Read authorized, allocated and completed counts, spent and reserved budget, and task/result expiry. No lookup usage.","tags":["Agent tasks"],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"id","in":"path","required":true,"description":"Task ID returned by creation.","schema":{"type":"string","pattern":"^task_[a-f0-9]{40}$"}}],"responses":{"200":{"description":"Success","headers":{"X-API-Version":{"description":"Exact selected response contract.","schema":{"type":"string","enum":["2.0.0"]}}},"content":{"application/json":{"schema":{"type":"object","required":["id","status","api_version","created_at","expires_at","result_expires_at","budget","operations"],"properties":{"id":{"type":"string","pattern":"^task_[a-f0-9]{40}$"},"status":{"type":"string","enum":["active","cancelled","expired"]},"api_version":{"type":"string","const":"2.0.0"},"created_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"result_expires_at":{"type":"string","format":"date-time"},"budget":{"type":"object","required":["currency","enforced","maximum_usd","spent_usd","reserved_usd","remaining_usd"],"properties":{"currency":{"type":"string","const":"USD"},"enforced":{"type":"boolean","const":true},"maximum_usd":{"type":"string","pattern":"^\\d+\\.\\d{4}$"},"spent_usd":{"type":"string","pattern":"^\\d+\\.\\d{4}$"},"reserved_usd":{"type":"string","pattern":"^\\d+\\.\\d{4}$"},"remaining_usd":{"type":"string","pattern":"^\\d+\\.\\d{4}$"}}},"operations":{"type":"array","items":{"type":"object","required":["operation","deep","count","allocated","completed","remaining"],"properties":{"operation":{"type":"string","enum":["email","carrier","caller","hlr","domain","dns","mx","country","ip","phone","postal"]},"deep":{"type":"boolean"},"count":{"type":"integer","minimum":1,"maximum":1000},"allocated":{"type":"integer","minimum":0},"completed":{"type":"integer","minimum":0},"remaining":{"type":"integer","minimum":0}}}}},"additionalProperties":true}}}},"400":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/task/{id}/cancel":{"post":{"operationId":"task_cancel","summary":"Cancel remaining task work","description":"Prevent new lookups. Started lookups may finish and incur their reserved charge. Completed results remain recoverable.","tags":["Agent tasks"],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"id","in":"path","required":true,"description":"Task ID returned by creation.","schema":{"type":"string","pattern":"^task_[a-f0-9]{40}$"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Success","headers":{"X-API-Version":{"description":"Exact selected response contract.","schema":{"type":"string","enum":["2.0.0"]}}},"content":{"application/json":{"schema":{"type":"object","required":["id","status","api_version","created_at","expires_at","result_expires_at","budget","operations"],"properties":{"id":{"type":"string","pattern":"^task_[a-f0-9]{40}$"},"status":{"type":"string","enum":["active","cancelled","expired"]},"api_version":{"type":"string","const":"2.0.0"},"created_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"result_expires_at":{"type":"string","format":"date-time"},"budget":{"type":"object","required":["currency","enforced","maximum_usd","spent_usd","reserved_usd","remaining_usd"],"properties":{"currency":{"type":"string","const":"USD"},"enforced":{"type":"boolean","const":true},"maximum_usd":{"type":"string","pattern":"^\\d+\\.\\d{4}$"},"spent_usd":{"type":"string","pattern":"^\\d+\\.\\d{4}$"},"reserved_usd":{"type":"string","pattern":"^\\d+\\.\\d{4}$"},"remaining_usd":{"type":"string","pattern":"^\\d+\\.\\d{4}$"}}},"operations":{"type":"array","items":{"type":"object","required":["operation","deep","count","allocated","completed","remaining"],"properties":{"operation":{"type":"string","enum":["email","carrier","caller","hlr","domain","dns","mx","country","ip","phone","postal"]},"deep":{"type":"boolean"},"count":{"type":"integer","minimum":1,"maximum":1000},"allocated":{"type":"integer","minimum":0},"completed":{"type":"integer","minimum":0},"remaining":{"type":"integer","minimum":0}}}}},"additionalProperties":true}}}},"400":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/task/{id}/lookup":{"post":{"operationId":"task_lookup","summary":"Run or recover a bounded lookup","description":"Reserve a conservative maximum charge and one authorized execution before running the existing lookup once. Reusing the same Idempotency-Key and inputs recovers the saved response without another lookup or usage unit. Unknown outcomes retain their reservation and never rerun automatically. Saved results are accessible for 48 hours from task creation. Inspect status_code and result, including saved lookup errors.","tags":["Agent tasks"],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ParseVersion"},{"name":"id","in":"path","required":true,"description":"Task ID returned by creation.","schema":{"type":"string","pattern":"^task_[a-f0-9]{40}$"}},{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique ID per intended request. Reuse the same ID with identical inputs on retries. Keep lookup values out of this header.","schema":{"type":"string","pattern":"^[A-Za-z0-9._:-]{1,128}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["operation","value"],"properties":{"operation":{"type":"string","enum":["email","carrier","caller","hlr","domain","dns","mx","country","ip","phone","postal"]},"value":{"type":"string","minLength":1,"maxLength":2048},"country":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"Optional for VAT, phone-family and Postal inputs."},"deep":{"type":"boolean","default":false}}}}}},"responses":{"200":{"description":"Saved execution; inspect status_code for the original lookup status.","headers":{"X-API-Version":{"description":"Exact selected response contract.","schema":{"type":"string","enum":["2.0.0"]}}},"content":{"application/json":{"schema":{"type":"object","required":["status_code","result","receipt"],"properties":{"status_code":{"type":"integer","minimum":200,"maximum":599},"result":{},"receipt":{"type":"object","required":["task_id","request_id","additional_cost_usd","checked_at"],"properties":{"task_id":{"type":"string"},"request_id":{"type":"string"},"additional_cost_usd":{"type":"string"},"checked_at":{"type":"string","format":"date-time"},"metered_unit":{"type":"boolean"}},"additionalProperties":true}},"additionalProperties":true}}}},"400":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Task, authentication, account limit or availability error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/account":{"get":{"operationId":"account","tags":["Account"],"summary":"Inspect account allowances and availability","description":"Check what your account can use, what remains, when allowances reset and what to do next. Requires a secret API key used server-side. Public and app keys are rejected. The response covers that key's organization, including work through other keys. Inspection is free: no pooled requests, included checks, on-demand spend or billable units, no reservations, and no account or payment changes. It remains inspectable after product rate, allowance or spending exhaustion. Request version headers and the team lookup default do not change this response. Use HTTP. Currently published SDKs have no Account method. Responses are private, no-store. A balance snapshot may be reused for less than one second from its read start. Missing information stays unknown. Held capacity can reduce balances. This advisory snapshot does not guarantee admission of the next lookup, and unknown paid capacity does not prove payment failure. Money uses USD decimal strings with four places. Check periodically and follow the separate inspection headers and Retry-After. Full reference: https://parseapi.com/docs/account","externalDocs":{"description":"Account guide","url":"https://parseapi.com/docs/account"},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"parameters":[{"name":"pretty","in":"query","required":false,"description":"Format the JSON response. Account and product selectors and deep are rejected.","schema":{"type":"boolean","default":false}}],"x-parseapi-billable":false,"responses":{"200":{"description":"Account snapshot. Inspect status and product status. HTTP 200 can include blocked or unknown availability. Retry-After may accompany temporarily unknown balances.","headers":{"Cache-Control":{"description":"Account responses are private and must not be publicly cached.","schema":{"type":"string","const":"private, no-store"}},"X-RateLimit-Limit":{"description":"Inspection requests allowed per organization per minute at the server handling this request. Separate from lookup RPM. Present after the inspection limit check.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Inspection requests remaining in this server minute window.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Seconds until this server inspection minute window resets, not a Unix timestamp.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Optional delay in seconds before retrying. Follow it when present.","schema":{"type":"integer","minimum":1}},"X-API-Version":{"description":"Fixed account reference contract, independent of the request version selector.","schema":{"type":"string","const":"2.0.0"}}},"content":{"application/json":{"schema":{"type":"object","required":["plan","status","requests","requests_per_minute","resets_at","products","spend","snapshot_at"],"properties":{"plan":{"type":"string","minLength":1,"description":"Effective plan code."},"status":{"type":"string","enum":["available","blocked","unknown"],"description":"Account access and the shared request allowance together. A top-level restriction applies to every product."},"reason":{"type":"string","minLength":1,"description":"Machine-readable reason, present when relevant. Allow new reason names."},"actions":{"type":"array","minItems":1,"items":{"type":"object","required":["action"],"properties":{"action":{"type":"string","minLength":1,"description":"Next step, such as retry, wait_for_reset, upgrade_plan, enable_on_demand, raise_spend_cap, check_billing or contact_support. Allow new action names."},"url":{"type":"string","format":"uri","description":"Optional destination for this action."},"at":{"type":"string","format":"date-time","description":"Optional UTC time when this action becomes relevant."}},"additionalProperties":true}},"requests":{"type":"object","required":["allowance","remaining"],"properties":{"allowance":{"type":"string","enum":["limited","unlimited","not_enforced","unknown"]},"remaining":{"type":["integer","null"],"minimum":0,"maximum":9007199254740991,"description":"Available pooled allowance. Null has different meanings. Inspect allowance. Some batches consume more than one unit. Zero can still accompany available status at the allowance boundary or during grace."},"grace":{"type":"string","enum":["pending","active","expired"],"description":"Present only when paid-plan grace is relevant. Free has no grace period."},"grace_until":{"type":"string","format":"date-time","description":"Grace deadline, present only when known."}},"additionalProperties":true},"requests_per_minute":{"type":"integer","minimum":1,"description":"Effective rate for ordinary lookups. Inspection response headers describe a separate limit."},"burst":{"type":"integer","minimum":1,"description":"Lookup burst allowance, present only when the account rate policy uses one."},"resets_at":{"type":"string","format":"date-time","description":"Allowance reset at 00:00 UTC on the first day of the next month, separate from subscription renewal."},"products":{"type":"object","required":["email","carrier","caller","hlr"],"properties":{"email":{"type":"object","required":["status","remaining","on_demand","price_usd"],"properties":{"status":{"type":"string","enum":["available","blocked","unknown"],"description":"Current advisory availability. A top-level restriction applies to every product."},"reason":{"type":"string","minLength":1,"description":"Machine-readable reason, present when relevant. Allow new reason names."},"actions":{"type":"array","minItems":1,"items":{"type":"object","required":["action"],"properties":{"action":{"type":"string","minLength":1,"description":"Next step, such as retry, wait_for_reset, upgrade_plan, enable_on_demand, raise_spend_cap, check_billing or contact_support. Allow new action names."},"url":{"type":"string","format":"uri","description":"Optional destination for this action."},"at":{"type":"string","format":"date-time","description":"Optional UTC time when this action becomes relevant."}},"additionalProperties":true}},"remaining":{"type":["integer","null"],"minimum":0,"maximum":9007199254740991,"description":"Included units still available, accounting for pending work. Null means unknown. Zero can still allow additional paid checks when on_demand is enabled and status is available."},"on_demand":{"type":["boolean","null"],"description":"Whether additional paid units are enabled under accepted terms. Null means unknown. Use status to check availability."},"price_usd":{"type":["string","null"],"pattern":"^\\d+\\.\\d{4}$","description":"Accepted price for an additional unit in USD. Included checks have no extra charge. For graduated Page pricing, the next unit has this maximum price. Its completed price can be lower as other work finishes."},"spend_cap":{"type":"object","required":["status","limit_usd","remaining_usd"],"properties":{"status":{"type":"string","enum":["limited","unlimited","unknown"]},"limit_usd":{"type":["string","null"],"pattern":"^\\d+\\.\\d{4}$","description":"Additional-usage ceiling in USD. Null means unlimited only when status is unlimited."},"remaining_usd":{"type":["string","null"],"pattern":"^\\d+\\.\\d{4}$","description":"Additional spending capacity in USD, accounting for capacity held for pending work. Null when no finite balance is known."}},"allOf":[{"if":{"properties":{"status":{"const":"limited"}},"required":["status"]},"then":{"properties":{"limit_usd":{"type":"string"}}},"else":{"properties":{"limit_usd":{"type":"null"},"remaining_usd":{"type":"null"}}}}],"additionalProperties":true,"description":"Product cap exception, present when the common spend status is per_product or unknown. Products still draw from one shared spending balance."}},"additionalProperties":true},"carrier":{"type":"object","required":["status","remaining","on_demand","price_usd"],"properties":{"status":{"type":"string","enum":["available","blocked","unknown"],"description":"Current advisory availability. A top-level restriction applies to every product."},"reason":{"type":"string","minLength":1,"description":"Machine-readable reason, present when relevant. Allow new reason names."},"actions":{"type":"array","minItems":1,"items":{"type":"object","required":["action"],"properties":{"action":{"type":"string","minLength":1,"description":"Next step, such as retry, wait_for_reset, upgrade_plan, enable_on_demand, raise_spend_cap, check_billing or contact_support. Allow new action names."},"url":{"type":"string","format":"uri","description":"Optional destination for this action."},"at":{"type":"string","format":"date-time","description":"Optional UTC time when this action becomes relevant."}},"additionalProperties":true}},"remaining":{"type":["integer","null"],"minimum":0,"maximum":9007199254740991,"description":"Included units still available, accounting for pending work. Null means unknown. Zero can still allow additional paid checks when on_demand is enabled and status is available."},"on_demand":{"type":["boolean","null"],"description":"Whether additional paid units are enabled under accepted terms. Null means unknown. Use status to check availability."},"price_usd":{"type":["string","null"],"pattern":"^\\d+\\.\\d{4}$","description":"Accepted price for an additional unit in USD. Included checks have no extra charge. For graduated Page pricing, the next unit has this maximum price. Its completed price can be lower as other work finishes."},"spend_cap":{"type":"object","required":["status","limit_usd","remaining_usd"],"properties":{"status":{"type":"string","enum":["limited","unlimited","unknown"]},"limit_usd":{"type":["string","null"],"pattern":"^\\d+\\.\\d{4}$","description":"Additional-usage ceiling in USD. Null means unlimited only when status is unlimited."},"remaining_usd":{"type":["string","null"],"pattern":"^\\d+\\.\\d{4}$","description":"Additional spending capacity in USD, accounting for capacity held for pending work. Null when no finite balance is known."}},"allOf":[{"if":{"properties":{"status":{"const":"limited"}},"required":["status"]},"then":{"properties":{"limit_usd":{"type":"string"}}},"else":{"properties":{"limit_usd":{"type":"null"},"remaining_usd":{"type":"null"}}}}],"additionalProperties":true,"description":"Product cap exception, present when the common spend status is per_product or unknown. Products still draw from one shared spending balance."}},"additionalProperties":true},"caller":{"type":"object","required":["status","remaining","on_demand","price_usd"],"properties":{"status":{"type":"string","enum":["available","blocked","unknown"],"description":"Current advisory availability. A top-level restriction applies to every product."},"reason":{"type":"string","minLength":1,"description":"Machine-readable reason, present when relevant. Allow new reason names."},"actions":{"type":"array","minItems":1,"items":{"type":"object","required":["action"],"properties":{"action":{"type":"string","minLength":1,"description":"Next step, such as retry, wait_for_reset, upgrade_plan, enable_on_demand, raise_spend_cap, check_billing or contact_support. Allow new action names."},"url":{"type":"string","format":"uri","description":"Optional destination for this action."},"at":{"type":"string","format":"date-time","description":"Optional UTC time when this action becomes relevant."}},"additionalProperties":true}},"remaining":{"type":["integer","null"],"minimum":0,"maximum":9007199254740991,"description":"Included units still available, accounting for pending work. Null means unknown. Zero can still allow additional paid checks when on_demand is enabled and status is available."},"on_demand":{"type":["boolean","null"],"description":"Whether additional paid units are enabled under accepted terms. Null means unknown. Use status to check availability."},"price_usd":{"type":["string","null"],"pattern":"^\\d+\\.\\d{4}$","description":"Accepted price for an additional unit in USD. Included checks have no extra charge. For graduated Page pricing, the next unit has this maximum price. Its completed price can be lower as other work finishes."},"spend_cap":{"type":"object","required":["status","limit_usd","remaining_usd"],"properties":{"status":{"type":"string","enum":["limited","unlimited","unknown"]},"limit_usd":{"type":["string","null"],"pattern":"^\\d+\\.\\d{4}$","description":"Additional-usage ceiling in USD. Null means unlimited only when status is unlimited."},"remaining_usd":{"type":["string","null"],"pattern":"^\\d+\\.\\d{4}$","description":"Additional spending capacity in USD, accounting for capacity held for pending work. Null when no finite balance is known."}},"allOf":[{"if":{"properties":{"status":{"const":"limited"}},"required":["status"]},"then":{"properties":{"limit_usd":{"type":"string"}}},"else":{"properties":{"limit_usd":{"type":"null"},"remaining_usd":{"type":"null"}}}}],"additionalProperties":true,"description":"Product cap exception, present when the common spend status is per_product or unknown. Products still draw from one shared spending balance."}},"additionalProperties":true},"hlr":{"type":"object","required":["status","remaining","on_demand","price_usd"],"properties":{"status":{"type":"string","enum":["available","blocked","unknown"],"description":"Current advisory availability. A top-level restriction applies to every product."},"reason":{"type":"string","minLength":1,"description":"Machine-readable reason, present when relevant. Allow new reason names."},"actions":{"type":"array","minItems":1,"items":{"type":"object","required":["action"],"properties":{"action":{"type":"string","minLength":1,"description":"Next step, such as retry, wait_for_reset, upgrade_plan, enable_on_demand, raise_spend_cap, check_billing or contact_support. Allow new action names."},"url":{"type":"string","format":"uri","description":"Optional destination for this action."},"at":{"type":"string","format":"date-time","description":"Optional UTC time when this action becomes relevant."}},"additionalProperties":true}},"remaining":{"type":["integer","null"],"minimum":0,"maximum":9007199254740991,"description":"Included units still available, accounting for pending work. Null means unknown. Zero can still allow additional paid checks when on_demand is enabled and status is available."},"on_demand":{"type":["boolean","null"],"description":"Whether additional paid units are enabled under accepted terms. Null means unknown. Use status to check availability."},"price_usd":{"type":["string","null"],"pattern":"^\\d+\\.\\d{4}$","description":"Accepted price for an additional unit in USD. Included checks have no extra charge. For graduated Page pricing, the next unit has this maximum price. Its completed price can be lower as other work finishes."},"spend_cap":{"type":"object","required":["status","limit_usd","remaining_usd"],"properties":{"status":{"type":"string","enum":["limited","unlimited","unknown"]},"limit_usd":{"type":["string","null"],"pattern":"^\\d+\\.\\d{4}$","description":"Additional-usage ceiling in USD. Null means unlimited only when status is unlimited."},"remaining_usd":{"type":["string","null"],"pattern":"^\\d+\\.\\d{4}$","description":"Additional spending capacity in USD, accounting for capacity held for pending work. Null when no finite balance is known."}},"allOf":[{"if":{"properties":{"status":{"const":"limited"}},"required":["status"]},"then":{"properties":{"limit_usd":{"type":"string"}}},"else":{"properties":{"limit_usd":{"type":"null"},"remaining_usd":{"type":"null"}}}}],"additionalProperties":true,"description":"Product cap exception, present when the common spend status is per_product or unknown. Products still draw from one shared spending balance."}},"additionalProperties":true}},"additionalProperties":{"type":"object","required":["status","remaining","on_demand","price_usd"],"properties":{"status":{"type":"string","enum":["available","blocked","unknown"],"description":"Current advisory availability. A top-level restriction applies to every product."},"reason":{"type":"string","minLength":1,"description":"Machine-readable reason, present when relevant. Allow new reason names."},"actions":{"type":"array","minItems":1,"items":{"type":"object","required":["action"],"properties":{"action":{"type":"string","minLength":1,"description":"Next step, such as retry, wait_for_reset, upgrade_plan, enable_on_demand, raise_spend_cap, check_billing or contact_support. Allow new action names."},"url":{"type":"string","format":"uri","description":"Optional destination for this action."},"at":{"type":"string","format":"date-time","description":"Optional UTC time when this action becomes relevant."}},"additionalProperties":true}},"remaining":{"type":["integer","null"],"minimum":0,"maximum":9007199254740991,"description":"Included units still available, accounting for pending work. Null means unknown. Zero can still allow additional paid checks when on_demand is enabled and status is available."},"on_demand":{"type":["boolean","null"],"description":"Whether additional paid units are enabled under accepted terms. Null means unknown. Use status to check availability."},"price_usd":{"type":["string","null"],"pattern":"^\\d+\\.\\d{4}$","description":"Accepted price for an additional unit in USD. Included checks have no extra charge. For graduated Page pricing, the next unit has this maximum price. Its completed price can be lower as other work finishes."},"spend_cap":{"type":"object","required":["status","limit_usd","remaining_usd"],"properties":{"status":{"type":"string","enum":["limited","unlimited","unknown"]},"limit_usd":{"type":["string","null"],"pattern":"^\\d+\\.\\d{4}$","description":"Additional-usage ceiling in USD. Null means unlimited only when status is unlimited."},"remaining_usd":{"type":["string","null"],"pattern":"^\\d+\\.\\d{4}$","description":"Additional spending capacity in USD, accounting for capacity held for pending work. Null when no finite balance is known."}},"allOf":[{"if":{"properties":{"status":{"const":"limited"}},"required":["status"]},"then":{"properties":{"limit_usd":{"type":"string"}}},"else":{"properties":{"limit_usd":{"type":"null"},"remaining_usd":{"type":"null"}}}}],"additionalProperties":true,"description":"Product cap exception, present when the common spend status is per_product or unknown. Products still draw from one shared spending balance."}},"additionalProperties":true},"description":"Metered products keyed by product name. URL and Screenshot appear when enabled. Allow additional product names with the same shape."},"spend":{"type":"object","required":["status","limit_usd","remaining_usd"],"properties":{"status":{"type":"string","enum":["limited","unlimited","per_product","unknown"]},"limit_usd":{"type":["string","null"],"pattern":"^\\d+\\.\\d{4}$","description":"Additional-usage ceiling in USD. Null means unlimited only when status is unlimited."},"remaining_usd":{"type":["string","null"],"pattern":"^\\d+\\.\\d{4}$","description":"Additional spending capacity in USD, accounting for capacity held for pending work. Null when no finite balance is known."}},"allOf":[{"if":{"properties":{"status":{"const":"limited"}},"required":["status"]},"then":{"properties":{"limit_usd":{"type":"string"}}},"else":{"properties":{"limit_usd":{"type":"null"},"remaining_usd":{"type":"null"}}}}],"additionalProperties":true,"description":"Shared additional-usage spending cap. Excludes the subscription price and does not increase the pooled request allowance."},"snapshot_at":{"type":["string","null"],"format":"date-time","description":"UTC time when the balance-read attempt began, or null if no snapshot result arrived in time. It can accompany unknown balances. Reused snapshots retain this time. It is not account-term age, last-change time, or a promise that all balances were read at one instant."}},"additionalProperties":true},"example":{"plan":"pro","status":"available","requests":{"allowance":"limited","remaining":49880},"requests_per_minute":1000,"resets_at":"2026-11-01T00:00:00.000Z","products":{"email":{"status":"available","remaining":50,"on_demand":true,"price_usd":"0.0070"},"carrier":{"status":"available","remaining":90,"on_demand":true,"price_usd":"0.0050"},"caller":{"status":"available","remaining":90,"on_demand":true,"price_usd":"0.0050"},"hlr":{"status":"available","remaining":90,"on_demand":true,"price_usd":"0.0050"}},"spend":{"status":"limited","limit_usd":"10.0000","remaining_usd":"8.5000"},"snapshot_at":"2026-10-10T12:00:00.000Z"}}}},"400":{"description":"invalid_request: unsupported account/product selectors or invalid pretty value.","headers":{"Cache-Control":{"description":"Account responses are private and must not be publicly cached.","schema":{"type":"string","const":"private, no-store"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_api_key: missing, invalid, archived, revoked or disabled credentials.","headers":{"Cache-Control":{"description":"Account responses are private and must not be publicly cached.","schema":{"type":"string","const":"private, no-store"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"permission_denied: a public or app key cannot inspect the account. Use a secret key on your server.","headers":{"Cache-Control":{"description":"Account responses are private and must not be publicly cached.","schema":{"type":"string","const":"private, no-store"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited: inspection safety limit or failed-authentication safety limit reached. No product allowance or spending is consumed.","headers":{"Cache-Control":{"description":"Account responses are private and must not be publicly cached.","schema":{"type":"string","const":"private, no-store"}},"X-RateLimit-Limit":{"description":"Inspection requests allowed per organization per minute at the server handling this request. Separate from lookup RPM. Present after the inspection limit check.","schema":{"type":"integer","minimum":1}},"X-RateLimit-Remaining":{"description":"Inspection requests remaining in this server minute window.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Seconds until this server inspection minute window resets, not a Unix timestamp.","schema":{"type":"integer","minimum":1}},"Retry-After":{"description":"Optional delay in seconds before retrying. Follow it when present.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"service_unavailable: authentication or inspection work is temporarily unavailable. Retry-After may be present. Missing balances after successful authentication can instead return HTTP 200 with unknown availability.","headers":{"Cache-Control":{"description":"Account responses are private and must not be publicly cached.","schema":{"type":"string","const":"private, no-store"}},"Retry-After":{"description":"Optional delay in seconds before retrying. Follow it when present.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"parameters":{"ParseVersion":{"name":"X-API-Version","in":"header","required":false,"description":"Exact response contract for this lookup. Overrides the saved team default for this request only. Legacy Parse-Version is also accepted; both headers must match if sent together. With neither header, keyed requests use that default and keyless self-lookups use 1.0.0. Invalid or unsupported values return invalid_request (400). Retired selections return api_version_retired (410). Reference/help URLs keep their documented version and do not use this selector.","schema":{"type":"string","enum":["1.0.0","2.0.0","2.1.0","2.2.0"],"example":"2.2.0"}}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key from the ParseAPI dashboard"},"BearerAuth":{"type":"http","scheme":"bearer","description":"Same key as X-API-Key, via Authorization: Bearer"}},"schemas":{"Error":{"type":"object","required":["code","message","docs","request_id"],"properties":{"code":{"type":"string","description":"Machine-readable error code","enum":["invalid_request","ambiguous_time","nonexistent_time","invalid_api_key","permission_denied","plan_required","not_found","api_version_retired","rate_limited","quota_exceeded","server_error","service_unavailable","dns_resolution_failed","task_invalid","task_not_found","task_request_conflict","task_budget_exceeded","task_limit_exceeded","task_terms_changed","task_expired","task_cancelled","task_in_progress","task_outcome_unknown","task_unavailable"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri","description":"Link to the docs section for this error"},"request_id":{"type":"string","description":"Send this if you contact support"}}}}}}