You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+67-12Lines changed: 67 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,9 +56,9 @@ parse.ip("8.8.8.8")
56
56
parse.ip.self()
57
57
parse.email("hello@gmail.com")
58
58
parse.vat("DE136695976")
59
-
parse.iban("DE89370400440532013000")
60
-
parse.bin("424242")
61
-
parse.npi("1881018208")
59
+
parse.bank("DE89370400440532013000")
60
+
parse.card("424242")
61
+
parse.provider("1881018208")
62
62
parse.phone("+14155552671")
63
63
parse.carrier("+14155552671")
64
64
parse.caller("+14155552671")
@@ -109,16 +109,18 @@ parse.mx("example.com")
109
109
parse.dns("example.com")
110
110
parse.dns("_dmarc.example.com", type="TXT")
111
111
parse.useragent(ua_string)
112
-
parse.vin("1HGCM82633A004352")
113
-
parse.naics("541511")
114
-
parse.naics.search("coffee shop", limit=5)
112
+
parse.vehicle("1HGCM82633A004352")
113
+
parse.industry("541511")
114
+
parse.industry.search("coffee shop", limit=5)
115
115
parse.tariff("8471.30.01.00")
116
116
parse.tariff.search("sunglasses")
117
117
parse.emoji("rocket")
118
118
parse.emoji.search("fire")
119
119
```
120
120
121
-
NAICS paid deep records include classification `deep.exclusions`, each with a description and linked codes. Generic exclusions can have no linked codes. Omitted or null exclusions in older responses remain unknown. Search results also include `match`: the matched `field` (`name`, `term` or `naics`) and `text`, plus `corrections` with `from` and `to` tokens for typo fallback. Corrections are empty for exact, plural and prefix matches. Direct code lookups omit `match`. Older responses may omit it.
121
+
The existing NAICS lookup and search methods remain available as compatibility names for Industry.
122
+
123
+
Industry paid deep records include classification `deep.exclusions`, each with a description and linked codes. Generic exclusions can have no linked codes. Omitted or null exclusions in older responses remain unknown. Search results also include `match`: the matched `field` (`name`, `term` or `naics`) and `text`, plus `corrections` with `from` and `to` tokens for typo fallback. Corrections are empty for exact, plural and prefix matches. Direct code lookups omit `match`. Older responses may omit it.
122
124
123
125
Responses are plain dicts, exactly the JSON the API returns. `country.states("US")` requests states directly; it does not fetch a country first. Required inputs are positional and optional behavior uses keyword arguments, leaving room for new options without changing existing calls. Reuse a client across calls. Use `with ParseAPI(...) as parse:` or call `parse.close()` when finished.
124
126
@@ -247,6 +249,32 @@ Address search uses context from the form: prefer postal, or city and state. An
247
249
248
250
HLR reports status at the last check. `live` means assigned and `connected` means reachable at that check. Cached results may be returned. Null means unconfirmed. Deep diagnostics stay within the same metered lookup.
249
251
252
+
Bank returns core `checks` for input, country, length, structure, checksum and national rules, plus an `issues` list. States are `passed`, `failed`, `not_checked` or `not_supported`. Unsupported national checking is not a failure. `valid` covers the implemented format and checksum rules, not account existence, ownership or payment reachability. Directory names and BICs may be null independently. Older responses may omit `checks` and `issues`, and future states and issue codes remain strings. Pass the original input unchanged so the API can report invalid characters. Deep `account` remains the BBAN remainder.
253
+
254
+
Bank inputs use `POST /bank` JSON bodies, keeping IBAN and account values out of request URLs. Pass original strings; the server owns normalization and validation. Avoid logging request bodies. IBAN deep can include `directory` with the immutable `edition`, resolved `country` and actual `match` grain (`bank`, `branch`, `prefix` or `none`); it is absent if no directory lookup ran. A match does not prove complete country coverage or payment reachability.
255
+
256
+
Use country requirements to build supported input fields. US ACH has an explicit helper with no deep option. It checks the routing format/ABA checksum and account-field syntax; `account_checksum` is `not_supported`. It preserves account characters and leading zeros. A nullable bank name is routing-directory identity, not account existence, ownership or ACH eligibility. The examples below are synthetic test inputs, not payment instructions.
Pass the original NPI as a string. `valid` checks its format and checksum; `registered` means a match in the stored NPPES snapshot. `active` reflects recorded NPI deactivation, not licensure. `excluded` is an NPI-only OIG LEIE match; `false` is not a complete exclusion clearance. These directory facts do not verify credentials, current practice contact or payment eligibility.
271
+
272
+
Invalid input returns `valid: false` with unknown provider fields. A checksum-valid number missing from the snapshot returns `registered: false`; unavailable storage remains an API error. Preserve `null` as unknown.
273
+
274
+
The default pooled lookup includes provider identity, specialty and practice contact where held. Paid `deep` adds `deactivated_at`, `medicare`, `opt_out` and `enrollments` from stored source files, with no separate check meter or live verification. `enrollments: null` means unavailable; `[]` means no enrollment rows are returned. The API omits unrequested `deep` and returns `{}` when requested on Free.
275
+
276
+
Paid Deep also returns `taxonomies` in published order, with taxonomy code, specialty label, primary flag and provider-reported license number/state, plus `enumerated_at`, `updated_at` and `reactivated_at` record dates. Reported licenses are not verified licenses. Null lists mean unavailable; empty lists mean the edition contains no entries. Core `sources` is available on every plan: NPPES, LEIE, PECOS and opt-out each have nullable edition metadata (`edition`, `published_at`, `through`, `imported_at`). Provider record dates are separate from source publication and completed import dates. Older responses may omit these additions. Edition details remain null until a verified source is served.
277
+
250
278
## Deep
251
279
252
280
Choose enrichment for the question you need answered.
@@ -257,10 +285,11 @@ Choose enrichment for the question you need answered.
257
285
| Domain | Registration dates, registrar, status and DNSSEC, included with a paid plan. Use `dns` for DNS records and `mx` for mail routing. |
258
286
| Email | A metered mailbox check with deliverability, catch-all, status, reason and address hints, using included email checks or enabled on-demand usage. |
259
287
| VAT | A metered registry check where supported, using included VAT checks or enabled on-demand usage. |
260
-
| Phone, Time, Date, Currency, Language, Emoji, IBAN, Point | Optional detail in the same pooled request on every plan. |
288
+
| Phone, Time, Date, Currency, Language, Emoji, Bank, Point | Optional detail in the same pooled request on every plan. |
261
289
| Country, State, District, City, Postal | The place profile on paid plans, including demographic and tax facts where held. |
262
-
| Name, NAICS | Name evidence or the industry definition profile on paid plans. |
263
-
| VIN, NPI, Tariff, Company | The complete product detail bag on paid plans. |
290
+
| Name, Industry | Name evidence or the industry definition profile on paid plans. |
291
+
| NPI | Deactivation date, Medicare enrollment, opt-out and enrollment rows from stored sources on paid plans. Exclusion evidence stays core. |
292
+
| Vehicle, Tariff, Company | The complete product detail bag on paid plans. |
264
293
| Weather | Specialist current measurements and the existing forecast, alert, air and history bag on paid plans. |
265
294
| Carrier, HLR | Optional diagnostic detail within the same metered core unit, including Free allowance units. No second gate or additional check. |
An explicit client `retries` setting overrides those defaults; `retries=0` always makes one attempt. Another attempt can consume additional usage if the earlier response was lost. Cancelling an async task stops the call and any retry wait. Automatic redirects are disabled.
310
339
340
+
Automatic retries wait at most five seconds per attempt. A longer valid `Retry-After` returns the original API error immediately without retrying early. Read `retry_after` on the error for the original header, or null when absent.
341
+
311
342
## Docs
312
343
313
344
Full field reference for every endpoint: [parseapi.com/docs](https://parseapi.com/docs)
314
345
315
-
BIN lookup accepts 6-11 digits as a string, including leading zeros. Spaces and hyphens are accepted. `prefix` is the actual longest match and can be shorter than the input. Unknown reference fields are null. `deep` adds an empty object on every plan.
346
+
## Card
347
+
348
+
Send 2–11 leading digits as a string. Core returns `bin`, `brand`, `brand_name`
349
+
and a CDN SVG `logo`. Brand detection uses reviewed network rules independently
350
+
of issuer records. Unknown or ambiguous prefixes return null brand fields and a
351
+
generic logo; a known network without reviewed artwork also uses the generic logo.
316
352
353
+
Optional Deep adds `prefix`, `issuer`, `country`, `type` and `prepaid`, included
354
+
in the same pooled request on every plan. Six or more digits enable directory
355
+
matching. Fewer digits return all-null Deep fields. Compare `deep.prefix` with
356
+
`bin`: equal is an exact recorded match; shorter is broader; null is no match.
357
+
The longest row wins, including null fields. `prepaid: null` means unknown, not
358
+
false. This is partial reference data, not card validity or payment acceptance.
Leading zeros are preserved. Only ASCII spaces, tabs, CR, LF and hyphens are
368
+
removed; raw input is limited to 64 characters. Invalid prefixes are rejected
369
+
before dispatch, accepted input is forwarded unchanged. Never send a full card number.
317
370
318
371
## Optional detail
319
372
320
-
The default response answers the common task. Ask for `deep` when you need more detail about that same result. Core fields stay equal. City, NAICS and Emoji searches put detail inside each result. Postal nearby and distance put metropolitan detail beside the entity it describes. Time conversion keeps target detail in `to.deep`; only the source has `deep.next_dst`.
373
+
The default response answers the common task. Ask for `deep` when you need more detail about that same result. Core fields stay equal. City, Industry and Emoji searches put detail inside each result. Postal nearby and distance put metropolitan detail beside the entity it describes. Time conversion keeps target detail in `to.deep`; only the source has `deep.next_dst`.
321
374
322
375
```python
323
376
basic = parse.time("America/New_York")
@@ -339,3 +392,5 @@ Pass a public hostname without a scheme, path, port or IP address. Stack returns
339
392
Successful checks may be reused for up to 24 hours. `pretty` optionally formats the wire JSON. Stack uses your plan's request allowance and API version 2.0.0 selected by this client.
340
393
341
394
Stack defaults to a 35-second transport timeout so a first scan has time to finish. Other lookups retain their 10-second default. An explicit client timeout takes precedence.
395
+
396
+
Vehicle lookups use `vin` as the input and response field. Existing VIN methods remain available for compatibility.
0 commit comments