parseapi 1.10.1__tar.gz → 1.10.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {parseapi-1.10.1 → parseapi-1.10.2}/PKG-INFO +5 -42
- {parseapi-1.10.1 → parseapi-1.10.2}/README.md +4 -41
- {parseapi-1.10.1 → parseapi-1.10.2}/api/public.json +0 -322
- {parseapi-1.10.1 → parseapi-1.10.2}/pyproject.toml +1 -1
- {parseapi-1.10.1 → parseapi-1.10.2}/smoke/smoke.py +0 -23
- {parseapi-1.10.1 → parseapi-1.10.2}/src/parseapi/__init__.py +1 -1
- {parseapi-1.10.1 → parseapi-1.10.2}/src/parseapi/_client.py +0 -92
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/test_client.py +6 -9
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/test_language.py +1 -3
- parseapi-1.10.1/tests/test_tariff.py +0 -92
- parseapi-1.10.1/tests/test_tariff_short_id.py +0 -92
- {parseapi-1.10.1 → parseapi-1.10.2}/.github/workflows/publish.yml +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/.github/workflows/test.yml +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/.gitignore +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/CHANGELOG.md +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/LICENSE +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/scripts/public_api.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/src/parseapi/city.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/src/parseapi/py.typed +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/bank-fixtures.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/emoji-artwork.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/emoji-catalog.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/measure-response.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/response-fixtures/clean-company-coverage.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/response-fixtures/clean-company-profile.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/response-fixtures/clean-emoji-catalog.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/response-fixtures/clean-emoji-metadata.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/response-fixtures/clean-provider.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/response-fixtures/clean-tariff-search.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/response-fixtures/clean-tariff.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/response-fixtures/clean-time.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/response-fixtures/clean-timezones.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/response-fixtures/standard-company-coverage.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/response-fixtures/standard-company-profile.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/response-fixtures/standard-emoji-catalog.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/response-fixtures/standard-emoji-metadata.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/response-fixtures/standard-provider.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/response-fixtures/standard-tariff-search.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/response-fixtures/standard-tariff.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/response-fixtures/standard-time.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/fixtures/response-fixtures/standard-timezones.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/test_bank.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/test_card_dx.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/test_city_canonical.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/test_city_quality.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/test_city_query_parity.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/test_company_directory.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/test_email_enrichment.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/test_emoji.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/test_measure_response.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/test_name_formatting.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/test_postal_localities.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/test_public_api.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/test_response_decoding.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/test_stack.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/test_time_complete.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/test_time_gaps.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/test_version.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.2}/tests/typing_company_directory.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.5
|
|
2
2
|
Name: parseapi
|
|
3
|
-
Version: 1.10.
|
|
3
|
+
Version: 1.10.2
|
|
4
4
|
Summary: Official ParseAPI client for Python. One key, minimal JSON, fast.
|
|
5
5
|
Project-URL: Homepage, https://parseapi.com
|
|
6
6
|
Project-URL: Documentation, https://parseapi.com/docs
|
|
@@ -64,7 +64,7 @@ Pass `country` when a postal code or national phone number needs disambiguation.
|
|
|
64
64
|
|
|
65
65
|
Results are plain data. Pass a returned code or coordinate to another operation when the task needs it. Check nullable values before composing the next call.
|
|
66
66
|
|
|
67
|
-
Use `parse.postal("28202", country="US", deep=True)` for US ZIP tax references. `deep.tax` names the levy and `deep.tax_rate` is a percentage, so `7.9` means 7.9%. The state, county, city and special components explain that combined rate. An exact address can differ. Country and state lookups provide their own geographic reference rates, which should not be added to the ZIP rate. `None` means unknown and `0` means known zero. Country `deep.tax_id_format` and `deep.tax_id_regex` describe registration-number format only. Use
|
|
67
|
+
Use `parse.postal("28202", country="US", deep=True)` for US ZIP tax references. `deep.tax` names the levy and `deep.tax_rate` is a percentage, so `7.9` means 7.9%. The state, county, city and special components explain that combined rate. An exact address can differ. Country and state lookups provide their own geographic reference rates, which should not be added to the ZIP rate. `None` means unknown and `0` means known zero. Country `deep.tax_id_format` and `deep.tax_id_regex` describe registration-number format only. Use for a metered registration check with `deep` explicitly enabled.
|
|
68
68
|
|
|
69
69
|
## Company directory
|
|
70
70
|
|
|
@@ -104,10 +104,8 @@ One method per endpoint, named after the route.
|
|
|
104
104
|
parse.ip("8.8.8.8")
|
|
105
105
|
parse.ip.self()
|
|
106
106
|
parse.email("hello@gmail.com")
|
|
107
|
-
parse.vat("DE136695976")
|
|
108
107
|
parse.bank("DE89370400440532013000")
|
|
109
108
|
parse.card("424242")
|
|
110
|
-
parse.provider("1881018208")
|
|
111
109
|
parse.phone("+14155552671")
|
|
112
110
|
parse.carrier("+14155552671")
|
|
113
111
|
parse.caller("+14155552671")
|
|
@@ -137,8 +135,6 @@ parse.state.districts("NC", country="US")
|
|
|
137
135
|
parse.district("37081")
|
|
138
136
|
parse.continent("NA")
|
|
139
137
|
parse.continent.countries("NA")
|
|
140
|
-
parse.bloc("EU")
|
|
141
|
-
parse.bloc.countries("EU")
|
|
142
138
|
parse.currency("USD")
|
|
143
139
|
parse.currency.rate("USD", "EUR")
|
|
144
140
|
parse.language("en")
|
|
@@ -165,8 +161,6 @@ parse.dns("_dmarc.example.com", type="TXT")
|
|
|
165
161
|
parse.useragent(ua_string)
|
|
166
162
|
parse.industry("541511")
|
|
167
163
|
parse.industry.search("coffee shop", limit=5)
|
|
168
|
-
parse.tariff("8471.30.01.00")
|
|
169
|
-
parse.tariff.search("sunglasses")
|
|
170
164
|
parse.emoji("rocket")
|
|
171
165
|
parse.emoji.search("fire")
|
|
172
166
|
```
|
|
@@ -200,7 +194,7 @@ Choose display names for one request:
|
|
|
200
194
|
parse.country("DE", lang="fr")
|
|
201
195
|
```
|
|
202
196
|
|
|
203
|
-
`lang` is optional on geography lookups and their lists/searches, Currency lookup, Language, Date, Time/Timezone, Emoji lookup/search, and unit discovery. IP, ASN
|
|
197
|
+
`lang` is optional on geography lookups and their lists/searches, Currency lookup, Language, Date, Time/Timezone, Emoji lookup/search, and unit discovery. IP, ASN and national Company number lookups also accept it for their geographic labels. Codes, native names, quantities and response structure retain their meanings. Source coverage determines which labels are translated; unavailable labels use the API's documented fallback.
|
|
204
198
|
|
|
205
199
|
The next call keeps its usual default unless it also supplies `lang`. Existing `deep` rules still apply. Date `format` and measurement `locale` remain explicit input-parsing controls.
|
|
206
200
|
|
|
@@ -286,19 +280,6 @@ Weather returns current conditions by default. Paid deep adds specialist current
|
|
|
286
280
|
parse.weather(40.7128, -74.006, deep=True, date="2026-08-15")
|
|
287
281
|
```
|
|
288
282
|
|
|
289
|
-
Tariff starts with the general schedule line. Paid deep adds units and the special and other schedule columns. An optional origin then resolves country-specific measures. The three calls below show those successive choices. Without origin, schedule detail is still returned and origin-dependent fields are null. A null effective rate is not a zero rate.
|
|
290
|
-
|
|
291
|
-
Tariff lookup and search accept the `edition` ID returned by Tariff, such as `ted_3`, and an optional `date` (`YYYY-MM-DD`). The edition pins exact immutable source bytes. A date is accepted only when verified source coverage exists. An edition without a date returns undated schedule context (`date: null`). Default requests use today. Paid detail exposes an open-string `reason` when `effective_rate` is null, including `incomplete_coverage`. A null rate never means zero. Explicit selections fail with `tariff_selection_mismatch` if an older server ignores the requested scope.
|
|
292
|
-
|
|
293
|
-
Origin means where the goods originate, not where they ship from. The effective rate covers matched stored schedule measures only. It is not complete duty or landed cost.
|
|
294
|
-
|
|
295
|
-
Codes contain 4, 6, 8 or 10 ASCII digits; dots and whitespace are optional. Search returns up to 20 description matches with parent `lineage` so a result named "Other" has context. Search is not product classification. In deep, `measures: null` means origin-dependent measures were not resolved. `measures: []` means the resolved lookup found none.
|
|
296
|
-
|
|
297
|
-
```python
|
|
298
|
-
parse.tariff("8471.30.01.00")
|
|
299
|
-
parse.tariff("8471.30.01.00", deep=True)
|
|
300
|
-
parse.tariff("8471.30.01.00", deep=True, origin="CN")
|
|
301
|
-
```
|
|
302
283
|
|
|
303
284
|
Address search uses context from the form: prefer postal, or city and state. An optional end-user `ip` is a locality hint for server-side calls. An empty result explains itself with `reason`: `more_input`, `missing_context` or `no_matches`. With suggestions, reason is null. Older responses may omit it, and future reasons remain strings. Catalog and lookup failures use the existing API errors.
|
|
304
285
|
|
|
@@ -315,21 +296,6 @@ parse.bank_requirements("US", format="us_ach")
|
|
|
315
296
|
parse.bank_us_ach(routing="011000015", account="0001234567")
|
|
316
297
|
```
|
|
317
298
|
|
|
318
|
-
## Provider lookup
|
|
319
|
-
|
|
320
|
-
```python
|
|
321
|
-
provider = parse.provider("1881018208")
|
|
322
|
-
profile = parse.provider("1881018208", deep=True)
|
|
323
|
-
```
|
|
324
|
-
|
|
325
|
-
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.
|
|
326
|
-
|
|
327
|
-
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.
|
|
328
|
-
|
|
329
|
-
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.
|
|
330
|
-
|
|
331
|
-
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. Provider record dates describe the provider record. Unknown dates stay null.
|
|
332
|
-
|
|
333
299
|
## Deep
|
|
334
300
|
|
|
335
301
|
Choose enrichment for the question you need answered.
|
|
@@ -339,12 +305,10 @@ Choose enrichment for the question you need answered.
|
|
|
339
305
|
| IP | Richer IP fields included with a paid plan. No separate check meter. |
|
|
340
306
|
| Domain | Registration dates, registrar, status and DNSSEC, included with a paid plan. Use `dns` for DNS records and `mx` for mail routing. |
|
|
341
307
|
| Email | A metered mailbox check with deliverability, catch-all, status, reason and address hints, using included email checks or enabled on-demand usage. |
|
|
342
|
-
| VAT | A metered registry check where supported, using included VAT checks or enabled on-demand usage. |
|
|
343
308
|
| Phone, Time, Date, Currency, Language, Emoji, Bank, Point | Optional detail in the same pooled request on every plan. |
|
|
344
309
|
| Country, State, District, City, Postal | The place profile on paid plans, including demographic and tax facts where held. |
|
|
345
310
|
| Name, Industry | Name evidence or the industry definition profile on paid plans. |
|
|
346
|
-
|
|
|
347
|
-
| Tariff, Company | The complete product detail bag on paid plans. |
|
|
311
|
+
| Company | The complete product detail bag on paid plans. |
|
|
348
312
|
| Weather | Specialist current measurements and the existing forecast, alert, air and history bag on paid plans. |
|
|
349
313
|
| Carrier, HLR | Optional diagnostic detail within the same metered core unit, including Free allowance units. No second gate or additional check. |
|
|
350
314
|
|
|
@@ -388,7 +352,7 @@ parse = ParseAPI(
|
|
|
388
352
|
|
|
389
353
|
Requires Python 3.9 or later. One dependency (httpx).
|
|
390
354
|
|
|
391
|
-
Ordinary lookups retry network failures, 429, and 500/502/503/504 responses twice by default. Carrier, caller, HLR, and email
|
|
355
|
+
Ordinary lookups retry network failures, 429, and 500/502/503/504 responses twice by default. Carrier, caller, HLR, and email with `deep=True` make one attempt by default. Address with `deep=True` also uses one attempt, reserving the same behavior for future verification.
|
|
392
356
|
|
|
393
357
|
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.
|
|
394
358
|
|
|
@@ -534,7 +498,6 @@ Reviewed children, ancestors and siblings use canonical lists with partial relat
|
|
|
534
498
|
Strict `ambiguity=error` can return HTTP 409 `ambiguous_city` with up to two safe candidate identities. The existing error constructor and unrelated error metadata are preserved; candidates are retained only for that status/code and never contain Deep. GeoJSON is available through HTTP; these typed City list methods do not return GeoJSON.
|
|
535
499
|
|
|
536
500
|
|
|
537
|
-
|
|
538
501
|
Reviewed name forms:
|
|
539
502
|
|
|
540
503
|
```python
|
|
@@ -45,7 +45,7 @@ Pass `country` when a postal code or national phone number needs disambiguation.
|
|
|
45
45
|
|
|
46
46
|
Results are plain data. Pass a returned code or coordinate to another operation when the task needs it. Check nullable values before composing the next call.
|
|
47
47
|
|
|
48
|
-
Use `parse.postal("28202", country="US", deep=True)` for US ZIP tax references. `deep.tax` names the levy and `deep.tax_rate` is a percentage, so `7.9` means 7.9%. The state, county, city and special components explain that combined rate. An exact address can differ. Country and state lookups provide their own geographic reference rates, which should not be added to the ZIP rate. `None` means unknown and `0` means known zero. Country `deep.tax_id_format` and `deep.tax_id_regex` describe registration-number format only. Use
|
|
48
|
+
Use `parse.postal("28202", country="US", deep=True)` for US ZIP tax references. `deep.tax` names the levy and `deep.tax_rate` is a percentage, so `7.9` means 7.9%. The state, county, city and special components explain that combined rate. An exact address can differ. Country and state lookups provide their own geographic reference rates, which should not be added to the ZIP rate. `None` means unknown and `0` means known zero. Country `deep.tax_id_format` and `deep.tax_id_regex` describe registration-number format only. Use for a metered registration check with `deep` explicitly enabled.
|
|
49
49
|
|
|
50
50
|
## Company directory
|
|
51
51
|
|
|
@@ -85,10 +85,8 @@ One method per endpoint, named after the route.
|
|
|
85
85
|
parse.ip("8.8.8.8")
|
|
86
86
|
parse.ip.self()
|
|
87
87
|
parse.email("hello@gmail.com")
|
|
88
|
-
parse.vat("DE136695976")
|
|
89
88
|
parse.bank("DE89370400440532013000")
|
|
90
89
|
parse.card("424242")
|
|
91
|
-
parse.provider("1881018208")
|
|
92
90
|
parse.phone("+14155552671")
|
|
93
91
|
parse.carrier("+14155552671")
|
|
94
92
|
parse.caller("+14155552671")
|
|
@@ -118,8 +116,6 @@ parse.state.districts("NC", country="US")
|
|
|
118
116
|
parse.district("37081")
|
|
119
117
|
parse.continent("NA")
|
|
120
118
|
parse.continent.countries("NA")
|
|
121
|
-
parse.bloc("EU")
|
|
122
|
-
parse.bloc.countries("EU")
|
|
123
119
|
parse.currency("USD")
|
|
124
120
|
parse.currency.rate("USD", "EUR")
|
|
125
121
|
parse.language("en")
|
|
@@ -146,8 +142,6 @@ parse.dns("_dmarc.example.com", type="TXT")
|
|
|
146
142
|
parse.useragent(ua_string)
|
|
147
143
|
parse.industry("541511")
|
|
148
144
|
parse.industry.search("coffee shop", limit=5)
|
|
149
|
-
parse.tariff("8471.30.01.00")
|
|
150
|
-
parse.tariff.search("sunglasses")
|
|
151
145
|
parse.emoji("rocket")
|
|
152
146
|
parse.emoji.search("fire")
|
|
153
147
|
```
|
|
@@ -181,7 +175,7 @@ Choose display names for one request:
|
|
|
181
175
|
parse.country("DE", lang="fr")
|
|
182
176
|
```
|
|
183
177
|
|
|
184
|
-
`lang` is optional on geography lookups and their lists/searches, Currency lookup, Language, Date, Time/Timezone, Emoji lookup/search, and unit discovery. IP, ASN
|
|
178
|
+
`lang` is optional on geography lookups and their lists/searches, Currency lookup, Language, Date, Time/Timezone, Emoji lookup/search, and unit discovery. IP, ASN and national Company number lookups also accept it for their geographic labels. Codes, native names, quantities and response structure retain their meanings. Source coverage determines which labels are translated; unavailable labels use the API's documented fallback.
|
|
185
179
|
|
|
186
180
|
The next call keeps its usual default unless it also supplies `lang`. Existing `deep` rules still apply. Date `format` and measurement `locale` remain explicit input-parsing controls.
|
|
187
181
|
|
|
@@ -267,19 +261,6 @@ Weather returns current conditions by default. Paid deep adds specialist current
|
|
|
267
261
|
parse.weather(40.7128, -74.006, deep=True, date="2026-08-15")
|
|
268
262
|
```
|
|
269
263
|
|
|
270
|
-
Tariff starts with the general schedule line. Paid deep adds units and the special and other schedule columns. An optional origin then resolves country-specific measures. The three calls below show those successive choices. Without origin, schedule detail is still returned and origin-dependent fields are null. A null effective rate is not a zero rate.
|
|
271
|
-
|
|
272
|
-
Tariff lookup and search accept the `edition` ID returned by Tariff, such as `ted_3`, and an optional `date` (`YYYY-MM-DD`). The edition pins exact immutable source bytes. A date is accepted only when verified source coverage exists. An edition without a date returns undated schedule context (`date: null`). Default requests use today. Paid detail exposes an open-string `reason` when `effective_rate` is null, including `incomplete_coverage`. A null rate never means zero. Explicit selections fail with `tariff_selection_mismatch` if an older server ignores the requested scope.
|
|
273
|
-
|
|
274
|
-
Origin means where the goods originate, not where they ship from. The effective rate covers matched stored schedule measures only. It is not complete duty or landed cost.
|
|
275
|
-
|
|
276
|
-
Codes contain 4, 6, 8 or 10 ASCII digits; dots and whitespace are optional. Search returns up to 20 description matches with parent `lineage` so a result named "Other" has context. Search is not product classification. In deep, `measures: null` means origin-dependent measures were not resolved. `measures: []` means the resolved lookup found none.
|
|
277
|
-
|
|
278
|
-
```python
|
|
279
|
-
parse.tariff("8471.30.01.00")
|
|
280
|
-
parse.tariff("8471.30.01.00", deep=True)
|
|
281
|
-
parse.tariff("8471.30.01.00", deep=True, origin="CN")
|
|
282
|
-
```
|
|
283
264
|
|
|
284
265
|
Address search uses context from the form: prefer postal, or city and state. An optional end-user `ip` is a locality hint for server-side calls. An empty result explains itself with `reason`: `more_input`, `missing_context` or `no_matches`. With suggestions, reason is null. Older responses may omit it, and future reasons remain strings. Catalog and lookup failures use the existing API errors.
|
|
285
266
|
|
|
@@ -296,21 +277,6 @@ parse.bank_requirements("US", format="us_ach")
|
|
|
296
277
|
parse.bank_us_ach(routing="011000015", account="0001234567")
|
|
297
278
|
```
|
|
298
279
|
|
|
299
|
-
## Provider lookup
|
|
300
|
-
|
|
301
|
-
```python
|
|
302
|
-
provider = parse.provider("1881018208")
|
|
303
|
-
profile = parse.provider("1881018208", deep=True)
|
|
304
|
-
```
|
|
305
|
-
|
|
306
|
-
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.
|
|
307
|
-
|
|
308
|
-
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.
|
|
309
|
-
|
|
310
|
-
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.
|
|
311
|
-
|
|
312
|
-
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. Provider record dates describe the provider record. Unknown dates stay null.
|
|
313
|
-
|
|
314
280
|
## Deep
|
|
315
281
|
|
|
316
282
|
Choose enrichment for the question you need answered.
|
|
@@ -320,12 +286,10 @@ Choose enrichment for the question you need answered.
|
|
|
320
286
|
| IP | Richer IP fields included with a paid plan. No separate check meter. |
|
|
321
287
|
| Domain | Registration dates, registrar, status and DNSSEC, included with a paid plan. Use `dns` for DNS records and `mx` for mail routing. |
|
|
322
288
|
| Email | A metered mailbox check with deliverability, catch-all, status, reason and address hints, using included email checks or enabled on-demand usage. |
|
|
323
|
-
| VAT | A metered registry check where supported, using included VAT checks or enabled on-demand usage. |
|
|
324
289
|
| Phone, Time, Date, Currency, Language, Emoji, Bank, Point | Optional detail in the same pooled request on every plan. |
|
|
325
290
|
| Country, State, District, City, Postal | The place profile on paid plans, including demographic and tax facts where held. |
|
|
326
291
|
| Name, Industry | Name evidence or the industry definition profile on paid plans. |
|
|
327
|
-
|
|
|
328
|
-
| Tariff, Company | The complete product detail bag on paid plans. |
|
|
292
|
+
| Company | The complete product detail bag on paid plans. |
|
|
329
293
|
| Weather | Specialist current measurements and the existing forecast, alert, air and history bag on paid plans. |
|
|
330
294
|
| Carrier, HLR | Optional diagnostic detail within the same metered core unit, including Free allowance units. No second gate or additional check. |
|
|
331
295
|
|
|
@@ -369,7 +333,7 @@ parse = ParseAPI(
|
|
|
369
333
|
|
|
370
334
|
Requires Python 3.9 or later. One dependency (httpx).
|
|
371
335
|
|
|
372
|
-
Ordinary lookups retry network failures, 429, and 500/502/503/504 responses twice by default. Carrier, caller, HLR, and email
|
|
336
|
+
Ordinary lookups retry network failures, 429, and 500/502/503/504 responses twice by default. Carrier, caller, HLR, and email with `deep=True` make one attempt by default. Address with `deep=True` also uses one attempt, reserving the same behavior for future verification.
|
|
373
337
|
|
|
374
338
|
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.
|
|
375
339
|
|
|
@@ -515,7 +479,6 @@ Reviewed children, ancestors and siblings use canonical lists with partial relat
|
|
|
515
479
|
Strict `ambiguity=error` can return HTTP 409 `ambiguous_city` with up to two safe candidate identities. The existing error constructor and unrelated error metadata are preserved; candidates are retained only for that status/code and never contain Deep. GeoJSON is available through HTTP; these typed City list methods do not return GeoJSON.
|
|
516
480
|
|
|
517
481
|
|
|
518
|
-
|
|
519
482
|
Reviewed name forms:
|
|
520
483
|
|
|
521
484
|
```python
|
|
@@ -154,34 +154,6 @@
|
|
|
154
154
|
],
|
|
155
155
|
"returns": "Json"
|
|
156
156
|
},
|
|
157
|
-
"bloc": {
|
|
158
|
-
"async": true,
|
|
159
|
-
"parameters": [
|
|
160
|
-
{
|
|
161
|
-
"kind": "POSITIONAL_OR_KEYWORD",
|
|
162
|
-
"name": "code",
|
|
163
|
-
"type": "str"
|
|
164
|
-
}
|
|
165
|
-
],
|
|
166
|
-
"returns": "Json"
|
|
167
|
-
},
|
|
168
|
-
"bloc.countries": {
|
|
169
|
-
"async": true,
|
|
170
|
-
"parameters": [
|
|
171
|
-
{
|
|
172
|
-
"kind": "POSITIONAL_OR_KEYWORD",
|
|
173
|
-
"name": "code",
|
|
174
|
-
"type": "str"
|
|
175
|
-
},
|
|
176
|
-
{
|
|
177
|
-
"default": null,
|
|
178
|
-
"kind": "KEYWORD_ONLY",
|
|
179
|
-
"name": "lang",
|
|
180
|
-
"type": "Optional[str]"
|
|
181
|
-
}
|
|
182
|
-
],
|
|
183
|
-
"returns": "Json"
|
|
184
|
-
},
|
|
185
157
|
"caller": {
|
|
186
158
|
"async": true,
|
|
187
159
|
"parameters": [
|
|
@@ -2248,29 +2220,6 @@
|
|
|
2248
2220
|
],
|
|
2249
2221
|
"returns": "Json"
|
|
2250
2222
|
},
|
|
2251
|
-
"npi": {
|
|
2252
|
-
"async": true,
|
|
2253
|
-
"parameters": [
|
|
2254
|
-
{
|
|
2255
|
-
"kind": "POSITIONAL_OR_KEYWORD",
|
|
2256
|
-
"name": "npi",
|
|
2257
|
-
"type": "str"
|
|
2258
|
-
},
|
|
2259
|
-
{
|
|
2260
|
-
"default": false,
|
|
2261
|
-
"kind": "KEYWORD_ONLY",
|
|
2262
|
-
"name": "deep",
|
|
2263
|
-
"type": "bool"
|
|
2264
|
-
},
|
|
2265
|
-
{
|
|
2266
|
-
"default": null,
|
|
2267
|
-
"kind": "KEYWORD_ONLY",
|
|
2268
|
-
"name": "lang",
|
|
2269
|
-
"type": "Optional[str]"
|
|
2270
|
-
}
|
|
2271
|
-
],
|
|
2272
|
-
"returns": "Json"
|
|
2273
|
-
},
|
|
2274
2223
|
"phone": {
|
|
2275
2224
|
"async": true,
|
|
2276
2225
|
"parameters": [
|
|
@@ -2426,29 +2375,6 @@
|
|
|
2426
2375
|
],
|
|
2427
2376
|
"returns": "Json"
|
|
2428
2377
|
},
|
|
2429
|
-
"provider": {
|
|
2430
|
-
"async": true,
|
|
2431
|
-
"parameters": [
|
|
2432
|
-
{
|
|
2433
|
-
"kind": "POSITIONAL_OR_KEYWORD",
|
|
2434
|
-
"name": "npi",
|
|
2435
|
-
"type": "str"
|
|
2436
|
-
},
|
|
2437
|
-
{
|
|
2438
|
-
"default": false,
|
|
2439
|
-
"kind": "KEYWORD_ONLY",
|
|
2440
|
-
"name": "deep",
|
|
2441
|
-
"type": "bool"
|
|
2442
|
-
},
|
|
2443
|
-
{
|
|
2444
|
-
"default": null,
|
|
2445
|
-
"kind": "KEYWORD_ONLY",
|
|
2446
|
-
"name": "lang",
|
|
2447
|
-
"type": "Optional[str]"
|
|
2448
|
-
}
|
|
2449
|
-
],
|
|
2450
|
-
"returns": "Json"
|
|
2451
|
-
},
|
|
2452
2378
|
"stack": {
|
|
2453
2379
|
"async": true,
|
|
2454
2380
|
"parameters": [
|
|
@@ -2530,64 +2456,6 @@
|
|
|
2530
2456
|
],
|
|
2531
2457
|
"returns": "Json"
|
|
2532
2458
|
},
|
|
2533
|
-
"tariff": {
|
|
2534
|
-
"async": true,
|
|
2535
|
-
"parameters": [
|
|
2536
|
-
{
|
|
2537
|
-
"kind": "POSITIONAL_OR_KEYWORD",
|
|
2538
|
-
"name": "code",
|
|
2539
|
-
"type": "str"
|
|
2540
|
-
},
|
|
2541
|
-
{
|
|
2542
|
-
"default": false,
|
|
2543
|
-
"kind": "KEYWORD_ONLY",
|
|
2544
|
-
"name": "deep",
|
|
2545
|
-
"type": "bool"
|
|
2546
|
-
},
|
|
2547
|
-
{
|
|
2548
|
-
"default": null,
|
|
2549
|
-
"kind": "KEYWORD_ONLY",
|
|
2550
|
-
"name": "origin",
|
|
2551
|
-
"type": "Optional[str]"
|
|
2552
|
-
},
|
|
2553
|
-
{
|
|
2554
|
-
"default": null,
|
|
2555
|
-
"kind": "KEYWORD_ONLY",
|
|
2556
|
-
"name": "edition",
|
|
2557
|
-
"type": "Optional[str]"
|
|
2558
|
-
},
|
|
2559
|
-
{
|
|
2560
|
-
"default": null,
|
|
2561
|
-
"kind": "KEYWORD_ONLY",
|
|
2562
|
-
"name": "date",
|
|
2563
|
-
"type": "Optional[str]"
|
|
2564
|
-
}
|
|
2565
|
-
],
|
|
2566
|
-
"returns": "Json"
|
|
2567
|
-
},
|
|
2568
|
-
"tariff.search": {
|
|
2569
|
-
"async": true,
|
|
2570
|
-
"parameters": [
|
|
2571
|
-
{
|
|
2572
|
-
"kind": "POSITIONAL_OR_KEYWORD",
|
|
2573
|
-
"name": "query",
|
|
2574
|
-
"type": "str"
|
|
2575
|
-
},
|
|
2576
|
-
{
|
|
2577
|
-
"default": null,
|
|
2578
|
-
"kind": "KEYWORD_ONLY",
|
|
2579
|
-
"name": "edition",
|
|
2580
|
-
"type": "Optional[str]"
|
|
2581
|
-
},
|
|
2582
|
-
{
|
|
2583
|
-
"default": null,
|
|
2584
|
-
"kind": "KEYWORD_ONLY",
|
|
2585
|
-
"name": "date",
|
|
2586
|
-
"type": "Optional[str]"
|
|
2587
|
-
}
|
|
2588
|
-
],
|
|
2589
|
-
"returns": "Json"
|
|
2590
|
-
},
|
|
2591
2459
|
"time": {
|
|
2592
2460
|
"async": true,
|
|
2593
2461
|
"parameters": [
|
|
@@ -2888,35 +2756,6 @@
|
|
|
2888
2756
|
],
|
|
2889
2757
|
"returns": "Json"
|
|
2890
2758
|
},
|
|
2891
|
-
"vat": {
|
|
2892
|
-
"async": true,
|
|
2893
|
-
"parameters": [
|
|
2894
|
-
{
|
|
2895
|
-
"kind": "POSITIONAL_OR_KEYWORD",
|
|
2896
|
-
"name": "number",
|
|
2897
|
-
"type": "str"
|
|
2898
|
-
},
|
|
2899
|
-
{
|
|
2900
|
-
"default": null,
|
|
2901
|
-
"kind": "KEYWORD_ONLY",
|
|
2902
|
-
"name": "country",
|
|
2903
|
-
"type": "Optional[str]"
|
|
2904
|
-
},
|
|
2905
|
-
{
|
|
2906
|
-
"default": false,
|
|
2907
|
-
"kind": "KEYWORD_ONLY",
|
|
2908
|
-
"name": "deep",
|
|
2909
|
-
"type": "bool"
|
|
2910
|
-
},
|
|
2911
|
-
{
|
|
2912
|
-
"default": null,
|
|
2913
|
-
"kind": "KEYWORD_ONLY",
|
|
2914
|
-
"name": "from_vat",
|
|
2915
|
-
"type": "Optional[str]"
|
|
2916
|
-
}
|
|
2917
|
-
],
|
|
2918
|
-
"returns": "Json"
|
|
2919
|
-
},
|
|
2920
2759
|
"weather": {
|
|
2921
2760
|
"async": true,
|
|
2922
2761
|
"parameters": [
|
|
@@ -3101,34 +2940,6 @@
|
|
|
3101
2940
|
],
|
|
3102
2941
|
"returns": "Json"
|
|
3103
2942
|
},
|
|
3104
|
-
"bloc": {
|
|
3105
|
-
"async": false,
|
|
3106
|
-
"parameters": [
|
|
3107
|
-
{
|
|
3108
|
-
"kind": "POSITIONAL_OR_KEYWORD",
|
|
3109
|
-
"name": "code",
|
|
3110
|
-
"type": "str"
|
|
3111
|
-
}
|
|
3112
|
-
],
|
|
3113
|
-
"returns": "Json"
|
|
3114
|
-
},
|
|
3115
|
-
"bloc.countries": {
|
|
3116
|
-
"async": false,
|
|
3117
|
-
"parameters": [
|
|
3118
|
-
{
|
|
3119
|
-
"kind": "POSITIONAL_OR_KEYWORD",
|
|
3120
|
-
"name": "code",
|
|
3121
|
-
"type": "str"
|
|
3122
|
-
},
|
|
3123
|
-
{
|
|
3124
|
-
"default": null,
|
|
3125
|
-
"kind": "KEYWORD_ONLY",
|
|
3126
|
-
"name": "lang",
|
|
3127
|
-
"type": "Optional[str]"
|
|
3128
|
-
}
|
|
3129
|
-
],
|
|
3130
|
-
"returns": "Json"
|
|
3131
|
-
},
|
|
3132
2943
|
"caller": {
|
|
3133
2944
|
"async": false,
|
|
3134
2945
|
"parameters": [
|
|
@@ -5195,29 +5006,6 @@
|
|
|
5195
5006
|
],
|
|
5196
5007
|
"returns": "Json"
|
|
5197
5008
|
},
|
|
5198
|
-
"npi": {
|
|
5199
|
-
"async": false,
|
|
5200
|
-
"parameters": [
|
|
5201
|
-
{
|
|
5202
|
-
"kind": "POSITIONAL_OR_KEYWORD",
|
|
5203
|
-
"name": "npi",
|
|
5204
|
-
"type": "str"
|
|
5205
|
-
},
|
|
5206
|
-
{
|
|
5207
|
-
"default": false,
|
|
5208
|
-
"kind": "KEYWORD_ONLY",
|
|
5209
|
-
"name": "deep",
|
|
5210
|
-
"type": "bool"
|
|
5211
|
-
},
|
|
5212
|
-
{
|
|
5213
|
-
"default": null,
|
|
5214
|
-
"kind": "KEYWORD_ONLY",
|
|
5215
|
-
"name": "lang",
|
|
5216
|
-
"type": "Optional[str]"
|
|
5217
|
-
}
|
|
5218
|
-
],
|
|
5219
|
-
"returns": "Json"
|
|
5220
|
-
},
|
|
5221
5009
|
"phone": {
|
|
5222
5010
|
"async": false,
|
|
5223
5011
|
"parameters": [
|
|
@@ -5373,29 +5161,6 @@
|
|
|
5373
5161
|
],
|
|
5374
5162
|
"returns": "Json"
|
|
5375
5163
|
},
|
|
5376
|
-
"provider": {
|
|
5377
|
-
"async": false,
|
|
5378
|
-
"parameters": [
|
|
5379
|
-
{
|
|
5380
|
-
"kind": "POSITIONAL_OR_KEYWORD",
|
|
5381
|
-
"name": "npi",
|
|
5382
|
-
"type": "str"
|
|
5383
|
-
},
|
|
5384
|
-
{
|
|
5385
|
-
"default": false,
|
|
5386
|
-
"kind": "KEYWORD_ONLY",
|
|
5387
|
-
"name": "deep",
|
|
5388
|
-
"type": "bool"
|
|
5389
|
-
},
|
|
5390
|
-
{
|
|
5391
|
-
"default": null,
|
|
5392
|
-
"kind": "KEYWORD_ONLY",
|
|
5393
|
-
"name": "lang",
|
|
5394
|
-
"type": "Optional[str]"
|
|
5395
|
-
}
|
|
5396
|
-
],
|
|
5397
|
-
"returns": "Json"
|
|
5398
|
-
},
|
|
5399
5164
|
"stack": {
|
|
5400
5165
|
"async": false,
|
|
5401
5166
|
"parameters": [
|
|
@@ -5477,64 +5242,6 @@
|
|
|
5477
5242
|
],
|
|
5478
5243
|
"returns": "Json"
|
|
5479
5244
|
},
|
|
5480
|
-
"tariff": {
|
|
5481
|
-
"async": false,
|
|
5482
|
-
"parameters": [
|
|
5483
|
-
{
|
|
5484
|
-
"kind": "POSITIONAL_OR_KEYWORD",
|
|
5485
|
-
"name": "code",
|
|
5486
|
-
"type": "str"
|
|
5487
|
-
},
|
|
5488
|
-
{
|
|
5489
|
-
"default": false,
|
|
5490
|
-
"kind": "KEYWORD_ONLY",
|
|
5491
|
-
"name": "deep",
|
|
5492
|
-
"type": "bool"
|
|
5493
|
-
},
|
|
5494
|
-
{
|
|
5495
|
-
"default": null,
|
|
5496
|
-
"kind": "KEYWORD_ONLY",
|
|
5497
|
-
"name": "origin",
|
|
5498
|
-
"type": "Optional[str]"
|
|
5499
|
-
},
|
|
5500
|
-
{
|
|
5501
|
-
"default": null,
|
|
5502
|
-
"kind": "KEYWORD_ONLY",
|
|
5503
|
-
"name": "edition",
|
|
5504
|
-
"type": "Optional[str]"
|
|
5505
|
-
},
|
|
5506
|
-
{
|
|
5507
|
-
"default": null,
|
|
5508
|
-
"kind": "KEYWORD_ONLY",
|
|
5509
|
-
"name": "date",
|
|
5510
|
-
"type": "Optional[str]"
|
|
5511
|
-
}
|
|
5512
|
-
],
|
|
5513
|
-
"returns": "Json"
|
|
5514
|
-
},
|
|
5515
|
-
"tariff.search": {
|
|
5516
|
-
"async": false,
|
|
5517
|
-
"parameters": [
|
|
5518
|
-
{
|
|
5519
|
-
"kind": "POSITIONAL_OR_KEYWORD",
|
|
5520
|
-
"name": "query",
|
|
5521
|
-
"type": "str"
|
|
5522
|
-
},
|
|
5523
|
-
{
|
|
5524
|
-
"default": null,
|
|
5525
|
-
"kind": "KEYWORD_ONLY",
|
|
5526
|
-
"name": "edition",
|
|
5527
|
-
"type": "Optional[str]"
|
|
5528
|
-
},
|
|
5529
|
-
{
|
|
5530
|
-
"default": null,
|
|
5531
|
-
"kind": "KEYWORD_ONLY",
|
|
5532
|
-
"name": "date",
|
|
5533
|
-
"type": "Optional[str]"
|
|
5534
|
-
}
|
|
5535
|
-
],
|
|
5536
|
-
"returns": "Json"
|
|
5537
|
-
},
|
|
5538
5245
|
"time": {
|
|
5539
5246
|
"async": false,
|
|
5540
5247
|
"parameters": [
|
|
@@ -5835,35 +5542,6 @@
|
|
|
5835
5542
|
],
|
|
5836
5543
|
"returns": "Json"
|
|
5837
5544
|
},
|
|
5838
|
-
"vat": {
|
|
5839
|
-
"async": false,
|
|
5840
|
-
"parameters": [
|
|
5841
|
-
{
|
|
5842
|
-
"kind": "POSITIONAL_OR_KEYWORD",
|
|
5843
|
-
"name": "number",
|
|
5844
|
-
"type": "str"
|
|
5845
|
-
},
|
|
5846
|
-
{
|
|
5847
|
-
"default": null,
|
|
5848
|
-
"kind": "KEYWORD_ONLY",
|
|
5849
|
-
"name": "country",
|
|
5850
|
-
"type": "Optional[str]"
|
|
5851
|
-
},
|
|
5852
|
-
{
|
|
5853
|
-
"default": false,
|
|
5854
|
-
"kind": "KEYWORD_ONLY",
|
|
5855
|
-
"name": "deep",
|
|
5856
|
-
"type": "bool"
|
|
5857
|
-
},
|
|
5858
|
-
{
|
|
5859
|
-
"default": null,
|
|
5860
|
-
"kind": "KEYWORD_ONLY",
|
|
5861
|
-
"name": "from_vat",
|
|
5862
|
-
"type": "Optional[str]"
|
|
5863
|
-
}
|
|
5864
|
-
],
|
|
5865
|
-
"returns": "Json"
|
|
5866
|
-
},
|
|
5867
5545
|
"weather": {
|
|
5868
5546
|
"async": false,
|
|
5869
5547
|
"parameters": [
|