parseapi 1.10.1__tar.gz → 1.10.3__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.3}/PKG-INFO +6 -52
- {parseapi-1.10.1 → parseapi-1.10.3}/README.md +5 -51
- {parseapi-1.10.1 → parseapi-1.10.3}/api/public.json +0 -480
- {parseapi-1.10.1 → parseapi-1.10.3}/pyproject.toml +1 -1
- {parseapi-1.10.1 → parseapi-1.10.3}/smoke/smoke.py +0 -29
- {parseapi-1.10.1 → parseapi-1.10.3}/src/parseapi/__init__.py +1 -1
- {parseapi-1.10.1 → parseapi-1.10.3}/src/parseapi/_client.py +0 -112
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/test_client.py +9 -18
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/test_language.py +1 -3
- parseapi-1.10.1/tests/bank-fixtures.json +0 -92
- parseapi-1.10.1/tests/test_bank.py +0 -69
- 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.3}/.github/workflows/publish.yml +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/.github/workflows/test.yml +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/.gitignore +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/CHANGELOG.md +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/LICENSE +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/scripts/public_api.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/src/parseapi/city.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/src/parseapi/py.typed +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/emoji-artwork.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/emoji-catalog.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/measure-response.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/response-fixtures/clean-company-coverage.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/response-fixtures/clean-company-profile.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/response-fixtures/clean-emoji-catalog.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/response-fixtures/clean-emoji-metadata.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/response-fixtures/clean-provider.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/response-fixtures/clean-tariff-search.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/response-fixtures/clean-tariff.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/response-fixtures/clean-time.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/response-fixtures/clean-timezones.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/response-fixtures/standard-company-coverage.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/response-fixtures/standard-company-profile.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/response-fixtures/standard-emoji-catalog.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/response-fixtures/standard-emoji-metadata.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/response-fixtures/standard-provider.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/response-fixtures/standard-tariff-search.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/response-fixtures/standard-tariff.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/response-fixtures/standard-time.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/fixtures/response-fixtures/standard-timezones.json +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/test_card_dx.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/test_city_canonical.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/test_city_quality.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/test_city_query_parity.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/test_company_directory.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/test_email_enrichment.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/test_emoji.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/test_measure_response.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/test_name_formatting.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/test_postal_localities.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/test_public_api.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/test_response_decoding.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/test_stack.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/test_time_complete.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/test_time_gaps.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/tests/test_version.py +0 -0
- {parseapi-1.10.1 → parseapi-1.10.3}/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.3
|
|
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,7 @@ 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
|
-
parse.bank("DE89370400440532013000")
|
|
109
107
|
parse.card("424242")
|
|
110
|
-
parse.provider("1881018208")
|
|
111
108
|
parse.phone("+14155552671")
|
|
112
109
|
parse.carrier("+14155552671")
|
|
113
110
|
parse.caller("+14155552671")
|
|
@@ -137,8 +134,6 @@ parse.state.districts("NC", country="US")
|
|
|
137
134
|
parse.district("37081")
|
|
138
135
|
parse.continent("NA")
|
|
139
136
|
parse.continent.countries("NA")
|
|
140
|
-
parse.bloc("EU")
|
|
141
|
-
parse.bloc.countries("EU")
|
|
142
137
|
parse.currency("USD")
|
|
143
138
|
parse.currency.rate("USD", "EUR")
|
|
144
139
|
parse.language("en")
|
|
@@ -165,8 +160,6 @@ parse.dns("_dmarc.example.com", type="TXT")
|
|
|
165
160
|
parse.useragent(ua_string)
|
|
166
161
|
parse.industry("541511")
|
|
167
162
|
parse.industry.search("coffee shop", limit=5)
|
|
168
|
-
parse.tariff("8471.30.01.00")
|
|
169
|
-
parse.tariff.search("sunglasses")
|
|
170
163
|
parse.emoji("rocket")
|
|
171
164
|
parse.emoji.search("fire")
|
|
172
165
|
```
|
|
@@ -200,7 +193,7 @@ Choose display names for one request:
|
|
|
200
193
|
parse.country("DE", lang="fr")
|
|
201
194
|
```
|
|
202
195
|
|
|
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
|
|
196
|
+
`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
197
|
|
|
205
198
|
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
199
|
|
|
@@ -286,49 +279,13 @@ Weather returns current conditions by default. Paid deep adds specialist current
|
|
|
286
279
|
parse.weather(40.7128, -74.006, deep=True, date="2026-08-15")
|
|
287
280
|
```
|
|
288
281
|
|
|
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
282
|
|
|
303
283
|
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
284
|
|
|
305
285
|
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.
|
|
306
286
|
|
|
307
|
-
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.
|
|
308
|
-
|
|
309
287
|
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.
|
|
310
288
|
|
|
311
|
-
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.
|
|
312
|
-
|
|
313
|
-
```python
|
|
314
|
-
parse.bank_requirements("US", format="us_ach")
|
|
315
|
-
parse.bank_us_ach(routing="011000015", account="0001234567")
|
|
316
|
-
```
|
|
317
|
-
|
|
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
289
|
|
|
333
290
|
## Deep
|
|
334
291
|
|
|
@@ -339,12 +296,10 @@ Choose enrichment for the question you need answered.
|
|
|
339
296
|
| IP | Richer IP fields included with a paid plan. No separate check meter. |
|
|
340
297
|
| Domain | Registration dates, registrar, status and DNSSEC, included with a paid plan. Use `dns` for DNS records and `mx` for mail routing. |
|
|
341
298
|
| Email | A metered mailbox check with deliverability, catch-all, status, reason and address hints, using included email checks or enabled on-demand usage. |
|
|
342
|
-
|
|
|
343
|
-
| Phone, Time, Date, Currency, Language, Emoji, Bank, Point | Optional detail in the same pooled request on every plan. |
|
|
299
|
+
| Phone, Time, Date, Currency, Language, Emoji, Point | Optional detail in the same pooled request on every plan. |
|
|
344
300
|
| Country, State, District, City, Postal | The place profile on paid plans, including demographic and tax facts where held. |
|
|
345
301
|
| Name, Industry | Name evidence or the industry definition profile on paid plans. |
|
|
346
|
-
|
|
|
347
|
-
| Tariff, Company | The complete product detail bag on paid plans. |
|
|
302
|
+
| Company | The complete product detail bag on paid plans. |
|
|
348
303
|
| Weather | Specialist current measurements and the existing forecast, alert, air and history bag on paid plans. |
|
|
349
304
|
| Carrier, HLR | Optional diagnostic detail within the same metered core unit, including Free allowance units. No second gate or additional check. |
|
|
350
305
|
|
|
@@ -388,7 +343,7 @@ parse = ParseAPI(
|
|
|
388
343
|
|
|
389
344
|
Requires Python 3.9 or later. One dependency (httpx).
|
|
390
345
|
|
|
391
|
-
Ordinary lookups retry network failures, 429, and 500/502/503/504 responses twice by default. Carrier, caller, HLR, and email
|
|
346
|
+
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
347
|
|
|
393
348
|
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
349
|
|
|
@@ -534,7 +489,6 @@ Reviewed children, ancestors and siblings use canonical lists with partial relat
|
|
|
534
489
|
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
490
|
|
|
536
491
|
|
|
537
|
-
|
|
538
492
|
Reviewed name forms:
|
|
539
493
|
|
|
540
494
|
```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,7 @@ 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
|
-
parse.bank("DE89370400440532013000")
|
|
90
88
|
parse.card("424242")
|
|
91
|
-
parse.provider("1881018208")
|
|
92
89
|
parse.phone("+14155552671")
|
|
93
90
|
parse.carrier("+14155552671")
|
|
94
91
|
parse.caller("+14155552671")
|
|
@@ -118,8 +115,6 @@ parse.state.districts("NC", country="US")
|
|
|
118
115
|
parse.district("37081")
|
|
119
116
|
parse.continent("NA")
|
|
120
117
|
parse.continent.countries("NA")
|
|
121
|
-
parse.bloc("EU")
|
|
122
|
-
parse.bloc.countries("EU")
|
|
123
118
|
parse.currency("USD")
|
|
124
119
|
parse.currency.rate("USD", "EUR")
|
|
125
120
|
parse.language("en")
|
|
@@ -146,8 +141,6 @@ parse.dns("_dmarc.example.com", type="TXT")
|
|
|
146
141
|
parse.useragent(ua_string)
|
|
147
142
|
parse.industry("541511")
|
|
148
143
|
parse.industry.search("coffee shop", limit=5)
|
|
149
|
-
parse.tariff("8471.30.01.00")
|
|
150
|
-
parse.tariff.search("sunglasses")
|
|
151
144
|
parse.emoji("rocket")
|
|
152
145
|
parse.emoji.search("fire")
|
|
153
146
|
```
|
|
@@ -181,7 +174,7 @@ Choose display names for one request:
|
|
|
181
174
|
parse.country("DE", lang="fr")
|
|
182
175
|
```
|
|
183
176
|
|
|
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
|
|
177
|
+
`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
178
|
|
|
186
179
|
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
180
|
|
|
@@ -267,49 +260,13 @@ Weather returns current conditions by default. Paid deep adds specialist current
|
|
|
267
260
|
parse.weather(40.7128, -74.006, deep=True, date="2026-08-15")
|
|
268
261
|
```
|
|
269
262
|
|
|
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
263
|
|
|
284
264
|
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
265
|
|
|
286
266
|
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.
|
|
287
267
|
|
|
288
|
-
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.
|
|
289
|
-
|
|
290
268
|
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.
|
|
291
269
|
|
|
292
|
-
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.
|
|
293
|
-
|
|
294
|
-
```python
|
|
295
|
-
parse.bank_requirements("US", format="us_ach")
|
|
296
|
-
parse.bank_us_ach(routing="011000015", account="0001234567")
|
|
297
|
-
```
|
|
298
|
-
|
|
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
270
|
|
|
314
271
|
## Deep
|
|
315
272
|
|
|
@@ -320,12 +277,10 @@ Choose enrichment for the question you need answered.
|
|
|
320
277
|
| IP | Richer IP fields included with a paid plan. No separate check meter. |
|
|
321
278
|
| Domain | Registration dates, registrar, status and DNSSEC, included with a paid plan. Use `dns` for DNS records and `mx` for mail routing. |
|
|
322
279
|
| Email | A metered mailbox check with deliverability, catch-all, status, reason and address hints, using included email checks or enabled on-demand usage. |
|
|
323
|
-
|
|
|
324
|
-
| Phone, Time, Date, Currency, Language, Emoji, Bank, Point | Optional detail in the same pooled request on every plan. |
|
|
280
|
+
| Phone, Time, Date, Currency, Language, Emoji, Point | Optional detail in the same pooled request on every plan. |
|
|
325
281
|
| Country, State, District, City, Postal | The place profile on paid plans, including demographic and tax facts where held. |
|
|
326
282
|
| Name, Industry | Name evidence or the industry definition profile on paid plans. |
|
|
327
|
-
|
|
|
328
|
-
| Tariff, Company | The complete product detail bag on paid plans. |
|
|
283
|
+
| Company | The complete product detail bag on paid plans. |
|
|
329
284
|
| Weather | Specialist current measurements and the existing forecast, alert, air and history bag on paid plans. |
|
|
330
285
|
| Carrier, HLR | Optional diagnostic detail within the same metered core unit, including Free allowance units. No second gate or additional check. |
|
|
331
286
|
|
|
@@ -369,7 +324,7 @@ parse = ParseAPI(
|
|
|
369
324
|
|
|
370
325
|
Requires Python 3.9 or later. One dependency (httpx).
|
|
371
326
|
|
|
372
|
-
Ordinary lookups retry network failures, 429, and 500/502/503/504 responses twice by default. Carrier, caller, HLR, and email
|
|
327
|
+
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
328
|
|
|
374
329
|
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
330
|
|
|
@@ -515,7 +470,6 @@ Reviewed children, ancestors and siblings use canonical lists with partial relat
|
|
|
515
470
|
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
471
|
|
|
517
472
|
|
|
518
|
-
|
|
519
473
|
Reviewed name forms:
|
|
520
474
|
|
|
521
475
|
```python
|