# ParseAPI

> Parse messy input into structured JSON. Read the selected endpoint's parameters, response fields, and coverage before integrating.

- Base: https://api.parseapi.com
- Auth: `X-API-Key` header (or `Authorization: Bearer`)
- OpenAPI: https://parseapi.com/openapi.json
- Try it: `curl "https://api.parseapi.com/ip/8.8.8.8" -H "X-API-Key: YOUR_API_KEY"`
- Start with one core lookup, inspect the returned JSON, then connect the fields the application needs. Prefer an official SDK for the project's language and runtime. Read its current installation instructions.

## Integration rules

- Lookup requests use GET at https://api.parseapi.com. Send X-API-Key, or Authorization: Bearer. Bare /ip and /useragent self-lookups also work without a key.
- Keep secret keys on the server and out of source control, logs, URLs, browser bundles, and mobile apps. Use a parse_public_ key for browsers and list the allowed domains, including localhost for local development. Use a parse_app_ key with the Swift or Kotlin SDK for native apps. List the exact bundle ID or package name and send X-App-Id.
- App keys support core lookups and plan deep. Metered endpoints return 403. Email and VAT deep return core plus deep: {} without a verification charge. Run metered checks from a server with a secret key.
- Read the selected endpoint's parameters and coverage before coding. Country is optional for State and Postal. Add a country code, such as ?country=US, when the input needs disambiguation. Encode values and query parameters instead of concatenating raw user input.
- Check HTTP status and response fields. false is a negative answer. null means no answer is available. An omitted field is absent from this response. Do not turn unknown values into false or reject a valid response because a new field appears.
- Deep is per endpoint. On successful responses, without ?deep=true, deep is omitted. When requested but unavailable for the endpoint, plan, or key type, deep is {}. When included, deep contains fields that may individually be null. Test the field you need, not the truthiness of an empty object. Phone already returns its full parsing result. ?deep=true only adds deep: {}. Exhausted metered allowances can return quota_exceeded instead of a lookup result.
- Plan deep is included on eligible paid plans. Email and VAT deep use metered allowances, including limited checks on Free. /carrier/{number} (carrier + line type), /caller/{number} (caller ID, NANP), /hlr/{number} (live phone status, worldwide) are separate metered lookups with included monthly units. Check https://parseapi.com/docs#usage and the selected endpoint for what counts as a unit. Use https://parseapi.com/plans for current allowances and rates.
- Errors contain code, message, docs, and request_id. Set a timeout. Honor Retry-After for rate_limited, and use bounded backoff for temporary connection failures, server_error, or service_unavailable. quota_exceeded needs allowance or billing action, not a retry loop. A timeout may follow a processed request. Repeating a metered check can consume another unit. Official SDKs default to no automatic retries for metered checks.
- Before running live metered checks or starting paid Bulk processing, explain the intended checks and usage, and get the user's approval unless that scope is already authorized. Do not enable paid checks, on-demand usage, or automatic metered retries as an incidental part of setup.

## Docs

- [Agent integration guide](https://parseapi.com/ai): instructions for discovering endpoints, making requests, and handling responses, errors, and usage
- [MCP](https://parseapi.com/mcp): connect to the hosted server at https://mcp.parseapi.com through browser sign-in, or use X-API-Key for headless access
- [OpenAPI](https://parseapi.com/openapi.json): machine-readable paths + auth (OpenAPI 3.1)
- [Docs](https://parseapi.com/docs): full API reference
- [Explore](https://parseapi.com/docs/explore): browse APIs, follow references, and inspect JSON responses
- [API versions](https://parseapi.com/docs/versioning): choose one team version in Dashboard → API version; it applies to every key. Existing teams retain 1.0.0; review and confirm an upgrade when ready
- [Release history](https://parseapi.com/docs/releases): API response changes and migration notes
- [API 2.0.0 release notes](https://parseapi.com/docs/releases/2.0.0): released; Core responses focus on the common task, with optional detail in deep. Review field moves, renamed fields, removals and plan requirements before changing your team’s version.
- [API 1.0.0 release notes](https://parseapi.com/docs/releases/1.0.0): original contract; The name for the API contract that existed before explicit version selection. Existing teams keep its response fields and access rules while they prepare an upgrade.
- [BIN Lookup API](https://parseapi.com/docs/bin): Card issuer details with the matched prefix in every response.
- [NAICS Code API](https://parseapi.com/docs/naics): Find an industry by code or business activity.
- [Measurement API](https://parseapi.com/docs/measure): Measurements in. A decimal amount and a consistent unit out.
- [ASN Lookup API](https://parseapi.com/docs/asn): A network organization and recorded country from its ASN.
- [MAC Address API](https://parseapi.com/docs/mac): A normalized MAC address, registered vendor, and address flags.
- [IP Address API](https://parseapi.com/docs/ip): Where an IP is from, country, ASN, network.
- [Continent API](https://parseapi.com/docs/continent): A continent by code, or every country in it.
- [Bloc API](https://parseapi.com/docs/bloc): A country group by code, or every member in it.
- [Country API](https://parseapi.com/docs/country): Country names, currency, languages, and timezones.
- [State API](https://parseapi.com/docs/state): A state or province by code or name, with timezones.
- [District API](https://parseapi.com/docs/district): A district by code or name, with its state and timezones.
- [City API](https://parseapi.com/docs/city): Exact name, typeahead, nearest, or nearby cities.
- [Postal API](https://parseapi.com/docs/postal): A ZIP or postal code to its city, state, coordinates, and timezone.
- [Address API](https://parseapi.com/docs/address): A US address, checked against official records.
- [Population](https://parseapi.com/docs/population): Population and its observation period, by place.
- [Tax](https://parseapi.com/docs/tax): Sales tax rates and US property-tax medians in paid place detail.
- [Point API](https://parseapi.com/docs/point): Country, state, district, and timezone at a coordinate.
- [Name API](https://parseapi.com/docs/name): A person's name, split, cased, and checked.
- [Email API](https://parseapi.com/docs/email): Format, domain, role, and a typo suggestion, on every call.
- [Phone Number API](https://parseapi.com/docs/phone): Validate and format a number. 245 countries and regions.
- [Carrier Lookup API](https://parseapi.com/docs/carrier): Who serves a number: carrier, line type, and burner.
- [Caller ID API](https://parseapi.com/docs/caller): The registered caller ID (CNAM) for a number.
- [HLR Lookup API](https://parseapi.com/docs/hlr): Assignment and reachability at the last network check.
- [VAT API](https://parseapi.com/docs/vat): Checksum a VAT number. Deep asks the live registry.
- [IBAN API](https://parseapi.com/docs/iban): Validate an IBAN. Bank details in 100 countries and territories.
- [Domain API](https://parseapi.com/docs/domain): Whether a domain is available to register.
- [DNS Lookup API](https://parseapi.com/docs/dns): DNS record names, types, values, and remaining TTLs.
- [MX API](https://parseapi.com/docs/mx): Mail exchange records for a domain.
- [NPI Lookup API](https://parseapi.com/docs/npi): A US provider, specialty, address, and registry status.
- [Useragent API](https://parseapi.com/docs/useragent): Device, OS, browser, and bot, from one header.
- [Currency API](https://parseapi.com/docs/currency): Currency names and symbols, plus daily exchange rates.
- [Language API](https://parseapi.com/docs/language): A language by ISO code, with name, script, and direction.
- [Time API](https://parseapi.com/docs/time): Local time, timezone lookup, and conversion.
- [Date API](https://parseapi.com/docs/date): An ISO date, validity, and Unix timestamp.
- [Holiday API](https://parseapi.com/docs/holiday): Public holidays by country and year, or check one date.
- [Elevation API](https://parseapi.com/docs/elevation): Elevation at a point, in feet and meters.
- [Weather API](https://parseapi.com/docs/weather): Current conditions at a latitude and longitude.
- [Emoji API](https://parseapi.com/docs/emoji): By character, shortcode, name, or search.
- [Tariff API](https://parseapi.com/docs/tariff): US import duty. An HTS code in. The rate and the measures that hit it.
- [VIN Decoder API](https://parseapi.com/docs/vin): Decode a VIN into year, make, model, and vehicle type.

## Why ParseAPI

- [Why ParseAPI](https://parseapi.com/why): the product choices behind the calls
- [Messy in. Useful out.](https://parseapi.com/why/clean): Turn the input people actually give you into data your app can use.
- [One key. A whole toolkit.](https://parseapi.com/why/key): Different questions. Familiar calls, responses and SDKs.
- [Speed you can see.](https://parseapi.com/why/speed): Explore real measurements. Then try your own connection.
- [One lookup. Or a million.](https://parseapi.com/why/bulk): The question stays the same. Choose an API call or a whole file.
- [An honest answer is useful.](https://parseapi.com/why/answers): Know what a result means, what matched and what is still unknown.
- [Simple by default. Deep by choice.](https://parseapi.com/deep): Start with the answer. Add the context when you need it.

## Tutorials

- [Tutorials](https://parseapi.com/tutorials): build complete features with working demos and downloadable examples
- [Autofill city and state from a ZIP code](https://parseapi.com/tutorials/zip-code-autofill): Mark a US ZIP field with form.js and fill editable city and state fields without writing lookup code.
- [Find nearby ZIP codes](https://parseapi.com/tutorials/zip-code-radius): Build a browser search that lists nearby US ZIP codes with distances in miles and kilometers, using an adjustable radius.
- [Calculate distance between ZIP codes](https://parseapi.com/tutorials/zip-code-distance): Build a browser calculator for straight-line distance between two US ZIP codes, with results in miles and kilometers.
- [Check an email as someone types](https://parseapi.com/tutorials/check-email-before-submit): Add email feedback and optional spelling corrections to your existing field with form.js.
- [Normalize a list of phone numbers](https://parseapi.com/tutorials/normalize-phone-numbers): Turn a phone list into consistent international numbers with Node or Python. Keep each original record.
- [Suggest a country from a visitor's IP address](https://parseapi.com/tutorials/suggest-country-from-ip): Get a visitor's country with one IP API request and use it for regional content, defaults, or a country picker.
- [Suggest states after choosing a country](https://parseapi.com/tutorials/country-state-dropdown): Use form.js to connect a country selector to an editable state, province, or region field.
- [Estimate a date in business days](https://parseapi.com/tutorials/add-business-days): Build a delivery-date estimator that skips weekends, observed public holidays, and your own closures, with a day-by-day explanation of the result.
- [Check an IBAN as someone types](https://parseapi.com/tutorials/validate-iban-javascript): Add IBAN structure and checksum feedback to an existing field with form.js.
- [Find an open store nearby](https://parseapi.com/tutorials/store-locator): Build a nearby branch list with approximate distances and opening status from your maintained schedules.
- [Show an event in the visitor's time zone](https://parseapi.com/tutorials/event-local-time): Put a webinar on your site with the right local start time for each visitor.
- [Add places to a ZIP-code CSV](https://parseapi.com/tutorials/enrich-zip-code-csv): Give a Python script your ZIP-code CSV. Get city, state, and timezone in new columns.
- [Add city autocomplete to an existing field](https://parseapi.com/tutorials/city-autocomplete): Use form.js to suggest cities and keep the selected city ID with your form.
- [Add address autocomplete to an existing field](https://parseapi.com/tutorials/address-autocomplete): Include form.js and add data-parse="address" to your input. Suggestions, keyboard navigation, and selection are handled for you.
- [Fill provider details from an NPI](https://parseapi.com/tutorials/npi-form-autofill): Use form.js to fill an editable provider name and specialty from a ten-digit NPI.
- [Fill vehicle details from a VIN](https://parseapi.com/tutorials/vin-form-autofill): Use form.js to fill editable year, make, and model fields from a VIN.
- [Verify email deliverability on the server](https://parseapi.com/tutorials/verify-email-server): Check one email on your server, request deliverability explicitly, and return a clear result.
- [Split full names into CRM columns](https://parseapi.com/tutorials/full-name-csv): Turn a full-name column into suggested first, middle, and last names. Keep the originals.
- [Clean up a CSV of mixed dates](https://parseapi.com/tutorials/clean-date-csv): Turn a date column into YYYY-MM-DD using one known date order. Keep unresolved rows for review.
- [Label a location from a map click](https://parseapi.com/tutorials/map-click-place): Move a pin, show a readable region label, and pass the selected coordinates into your application.
- [Find shared working hours](https://parseapi.com/tutorials/meeting-time-overlap): Choose two time zones and a date to find the overlap between their local working hours.
- [Build a local weather card](https://parseapi.com/tutorials/weather-card): Turn a postal code into a weather card with current conditions, an observation time, and a simple way to change places.
- [Show opening hours on a business page](https://parseapi.com/tutorials/business-open-now): Display opening status automatically from maintained local hours and an explicit holiday policy.
- [Build a currency picker](https://parseapi.com/tutorials/currency-picker): Suggest a display currency from a country, let people change it, and apply only the choice they accept.
- [Convert an expense CSV to one currency](https://parseapi.com/tutorials/expense-currency-csv): Convert expense amounts into one currency and record the dated rate used for each row.
- [Turn inbound emails into CRM contact drafts](https://parseapi.com/tutorials/email-to-crm): Turn an existing AI extraction into a normalized contact draft with the original message and specific review items.
- [Accept height in feet, inches, or centimeters](https://parseapi.com/tutorials/height-form): Let people enter a height naturally and keep a consistent centimeter value for your form.
- [Clean a CSV of mixed measurements](https://parseapi.com/tutorials/clean-measurement-csv): Convert a measurement column to one chosen unit, preserve original values, and keep ambiguous rows for review.

## SDKs

Official clients (https://parseapi.com/sdks). One method per endpoint, named after the route. MIT licensed. Swift and Kotlin take an app key and send the bundle ID.

- Node: `npm install @parseapi/sdk` (https://github.com/parseapi/node)
- Python: `pip install parseapi` (https://github.com/parseapi/python)
- Go: `go get github.com/parseapi/go` (https://github.com/parseapi/go)
- Ruby: `gem install parseapi` (https://github.com/parseapi/ruby)
- PHP: `composer require parseapi/sdk` (https://github.com/parseapi/php)
- Rust: `cargo add parseapi
cargo add tokio --features macros,rt-multi-thread` (https://github.com/parseapi/rust)
- Swift: `.package(url: "https://github.com/parseapi/swift", from: "0.3.1")` (https://github.com/parseapi/swift)
- Kotlin: `git clone --branch 0.3.1 https://github.com/parseapi/kotlin.git ../parseapi-kotlin` (https://github.com/parseapi/kotlin)

## Bulk

The same lookups over whole files, no code. Upload a CSV, Excel, or Numbers file and download a copy with parse_ columns added. Review the free sample, choose columns, and approve the exact quote before paid processing. Pricing follows the selected checks, unique values, and the account's plan. Use the quote and current product pages for pricing, refund rules, and download availability.

- [Bulk CSV cleaning](https://parseapi.com/bulk): one drop, every column we can parse (emails, phones, IPs, domains, user agents, countries, postal codes, names, dates, measurements)
- [Bulk email verification](https://parseapi.com/bulk/email): deliverability, disposable, and role flags on every row
- [Bulk phone validation](https://parseapi.com/bulk/phone): validity and formats on every row, carrier and live status as toggles
- [Bulk IP lookup](https://parseapi.com/bulk/ip): country, city, network operator, datacenter and VPN flags on every row
- [Bulk domain lookup](https://parseapi.com/bulk/domain): registration status and the registrar for every domain
- [Bulk ZIP code lookup](https://parseapi.com/bulk/zip): city, state, coordinates, and timezone on every row

## Free tools

Interactive, no signup to try. Publisher accounts register sites for embeds. API lookups use our public APIs. Date calculations, service ZIP matching, and the bundled planting-zone reference run in the browser.

- [Unit converter](https://parseapi.com/tool/unit-converter): parse mixed measurements and convert compatible units, with explicit number locale and unit system
- [Planting zone by ZIP code](https://parseapi.com/tool/planting-zone-by-zip-code): planting zone by ZIP, with an optional plant hardiness range for nursery embeds
- [ZIP code service area checker](https://parseapi.com/tool/zip-code-service-area-checker): visitor ZIP matching against up to 200 publisher-configured US ZIP codes, browser-only
- [HTS code lookup](https://parseapi.com/tool/hts-code-lookup): search US tariff descriptions and inspect code lineage, published base duties, and schedule revision

- [Split first and last names](https://parseapi.com/tool/split-names): paste full names, get clean first, middle, and last columns back
- [ZIP code radius finder](https://parseapi.com/tool/zip-code-radius-finder): up to 100 nearby ZIPs with city, state, and straight-line distance, CSV export
- [Distance between ZIP codes](https://parseapi.com/tool/zip-code-distance): straight-line miles and kilometers between two ZIPs
- [Area code lookup](https://parseapi.com/tool/area-code-lookup): the state or province behind any North American area code
- [What is my elevation](https://parseapi.com/tool/what-is-my-elevation): height above sea level in feet and meters, from your location or any coordinates
- [Time zone by ZIP code](https://parseapi.com/tool/timezone-by-zip): the time zone and current local time for any US ZIP
- [County lookup by ZIP code](https://parseapi.com/tool/county-by-zip): the county and FIPS code behind any US ZIP
- [What is my user agent](https://parseapi.com/tool/what-is-my-user-agent): your User-Agent string parsed on load, or paste any string
- [What is my IP](https://parseapi.com/tool/what-is-my-ip): your public IP, country, and network on load, or look up any address
- [Email checker](https://parseapi.com/tool/email-checker): shape, domain, disposable, and role checks for any email address
- [IBAN checker](https://parseapi.com/tool/iban-checker): format and checksum validation, print formatting, and available bank details
- [Business days calculator](https://parseapi.com/tool/business-days-calculator): count weekdays between dates, with optional UK regional bank-holiday exclusion
- [Phone number validator](https://parseapi.com/tool/phone-number-validator): check numbering-plan validity and get E.164, national, and international formats, no live-status check
- [Public holidays](https://parseapi.com/tool/public-holidays): official holiday calendars by country with the next one counted down
- [Currency converter](https://parseapi.com/tool/currency-converter): convert amounts with daily reference rates
- [MX lookup](https://parseapi.com/tool/mx-lookup): the mail servers behind any domain, live from DNS
- [Distance between cities](https://parseapi.com/tool/distance-between-cities): straight-line miles and kilometers between any two cities
- [Domain availability checker](https://parseapi.com/tool/domain-availability-checker): check whether a domain is available or taken
- [State abbreviations list](https://parseapi.com/tool/state-abbreviations): all 50 two-letter codes plus DC, territories, and military regions
- [What time zone am I in](https://parseapi.com/tool/what-time-zone-am-i-in): your zone from your location, with the next daylight change
- [Emoji copy and paste](https://parseapi.com/tool/emoji-copy-paste): search every emoji by keyword, click to copy
- [Weather at my location](https://parseapi.com/tool/weather-at-my-location): current conditions from the nearest official station
- [ZIP code lookup](https://parseapi.com/tool/zip-code-lookup): city, county, timezone, and coordinates for a US ZIP
- [Country codes list](https://parseapi.com/tool/country-codes): ISO alpha-2, alpha-3, numeric, and calling codes in one table
- [What county am I in](https://parseapi.com/tool/what-county-am-i-in): the county at your exact coordinates from real boundaries
- [Time zone converter](https://parseapi.com/tool/time-zone-converter): a time and two zones in, the local time out

## Product

- [WHOIS lookup](https://parseapi.com/whois): domain registration dates, registrar, and status on paid plans. Uses `GET /domain/{domain}?deep=true`; read the [Domain API reference](https://parseapi.com/docs/domain) for the response and coverage. Results are cached.
- [Plans](https://parseapi.com/plans): plans and monthly quotas
- [FAQ](https://parseapi.com/faq): limits, billing, and how quotas work

## Optional

- [Useragent directory](https://parseapi.com/useragent): browsers, bots, operating systems, engines, and devices
- [Area codes](https://parseapi.com/phone/area-code): every North American area code with the state it serves, time zone, and in-service date
- [About](https://parseapi.com/about): the ParseAPI story
- [Brand](https://parseapi.com/brand): wordmark, icon, colors, and downloadable assets
- [Pulse](https://parseapi.com/pulse): live status and latency