canonical: https://jentic.com/apis/interzoid.com/interzoid-get-city-match-similarity-key-api # Interzoid Get City Match Similarity Key API The Interzoid Get City Match Similarity Key API returns an algorithmic similarity key for a given city name string. Two records that refer to the same city - even when spelled inconsistently as 'NYC', 'New York', or 'New York City' - produce the same key, so deduplication and fuzzy-matching jobs can join on the key instead of the raw text. The single GET /getcitymatch endpoint authenticates with a license key passed as a query parameter and returns the similarity key as JSON. ## For AI agents Generate a similarity key for a city name to deduplicate or fuzzy-match city columns across datasets. One GET endpoint, license-key auth. ## Scope Does not standardise city names to a canonical form, validate that a city exists, or geocode addresses - use for fuzzy-match key generation on city strings only. ## Capabilities - Generate a deterministic similarity key for a city name string - Deduplicate customer records that hold the same city under different spellings - Join two datasets on city by hashing each side to a similarity key first - Cluster ticketing or order records by metropolitan area despite formatting variations - Build match keys for city columns in MDM and data warehouse pipelines ## Use cases ### Customer table deduplication on city Data engineers run every row's city value through the Interzoid Get City Match Similarity Key API and group records by the returned key to find duplicates. Records spelled 'NYC', 'New York', and 'New York City' collapse to the same key, surfacing duplicates that exact-match logic would miss. The endpoint accepts one city per call so batches use a thread pool sized to the account rate limit. Example prompt: Iterate the customers table, call /getcitymatch with city set to each row's city value, and group rows by the returned similarity key. ### Cross-dataset join on city When merging a CRM export with a marketing list, exact joins on city fail because the two systems format city names differently. By computing the Interzoid similarity key for both sides and joining on the key, the merge captures matches the literal string compare misses, without writing custom regex or stemming code. Example prompt: Compute /getcitymatch keys for the city column in both CRM and marketing exports, then join on the key to produce a unified contact view. ### MDM city standardisation pipeline Master data management pipelines call the Interzoid Get City Match Similarity Key API to assign each incoming customer record a stable city cluster ID. Variants flow into the same cluster automatically, and downstream BI dashboards aggregate by cluster ID rather than by raw text, producing accurate per-city counts. Example prompt: On every insert into the customers staging table, call /getcitymatch and store the returned key as city_match_key for downstream aggregation. ### AI agent record-deduplication assistant An AI agent helping an analyst clean a contact list discovers the Interzoid Get City Match Similarity Key API through Jentic and uses it to flag rows that look like the same city under different spellings. Jentic stores the Interzoid license key in the credential vault and injects it as the license query parameter at execution time, so the agent never sees the raw key. Example prompt: Search Jentic for 'similarity key for city name', load the Interzoid Get City Match operation, and execute it for each unique city string in the contacts file. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/getcitymatch` | Return a similarity key for a city name | ## Key resources - **City match similarity key** — Single GET operation that accepts a city name and returns an algorithmic similarity key for fuzzy matching. ## Why Jentic - **Setup:** Wiring the Interzoid Get City Match Similarity Key API by hand means passing your licence key as a query parameter on every call and remembering the single /getcitymatch endpoint. Through Jentic you install once, import the Interzoid Get City Match Similarity Key API from the API Directory, store the licence key once, and your agent calls it. - **Permission scoping:** This API exposes one read-only operation, GET /getcitymatch, with the city string in the query, so limit the agent to that operation. It performs no writes or deletes, so there is nothing destructive to add. - **Credential handling:** Your Interzoid licence key is stored once, encrypted, by your own Jentic One instance and injected as the license query parameter at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'similarity key for a city name' or 'fuzzy match cities', and Jentic returns the GET /getcitymatch operation with its parameter schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Interzoid City Data Standardization API** — Standardises a city name to a canonical form rather than producing a similarity key - **Interzoid Get Country Match Similarity Key API** — Same similarity-key approach applied to country names; pair with city for full address fuzzy matching - **Interzoid Get Address Match Similarity Key API** — Operates on a full street address rather than a city alone, returning a similarity key for the whole address ## FAQ ### What authentication does the Interzoid Get City Match Similarity Key API use? The API uses a license key passed as the license query parameter on every call to /getcitymatch. Through Jentic the license key is held in the credential vault and injected at execution time, so the agent never handles the raw key. ### Can I match cities that include the state or country in the same field? The /getcitymatch endpoint takes a single city string. It is most reliable when state and country are stripped first; if your records combine them, parse the components and call this API for the city portion only. ### What are the rate limits for the Interzoid Get City Match Similarity Key API? The OpenAPI spec does not publish a numeric rate limit. Interzoid enforces per-license-tier quotas on the account dashboard, so check your account before running batch deduplication jobs. ### How do I deduplicate a city column through Jentic? Install the SDK with pip install jentic, search for 'similarity key for city name', load the Interzoid Get City Match operation, and execute it for each city in your dataset, then group rows by the returned key. ### Does the API match cities across languages or transliterations? The similarity algorithm targets common English-language variations and typos. For non-Latin scripts or significant transliteration differences, normalize the input before calling /getcitymatch for best results. ### Can I limit what my agent is allowed to do with the Interzoid Get City Match Similarity Key API? Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials the agent may use, and this API exposes just one read-only operation, GET /getcitymatch, so you can allow that single call and nothing else. It performs no writes or deletes, so there is no destructive action to grant, and the agent only ever gets a similarity key back for a city string you pass in. Your Interzoid license key stays under your control and is injected as the license query parameter at execution time rather than exposed to the agent.