-
Notifications
You must be signed in to change notification settings - Fork 3
Document residential sub-object of the anonymizer object #1701
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -235,6 +235,9 @@ For full examples of response bodies, select one of the following: | |||||
| an anonymizing service or network. This data is available for GeoIP Insights | ||||||
| only. | ||||||
|
|
||||||
| The `residential` sub-object may be present even when none of the other | ||||||
| `anonymizer` fields are populated. | ||||||
|
|
||||||
| ```json | ||||||
| { | ||||||
| "confidence": 99, | ||||||
|
|
@@ -245,7 +248,12 @@ only. | |||||
| "is_residential_proxy": true, | ||||||
| "is_tor_exit_node": true, | ||||||
| "network_last_seen": "2025-01-15", | ||||||
| "provider_name": "nordvpn" | ||||||
| "provider_name": "nordvpn", | ||||||
| "residential": { | ||||||
| "confidence": 82, | ||||||
| "network_last_seen": "2026-05-11", | ||||||
| "provider_name": "quickshift" | ||||||
| } | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
|
|
@@ -323,6 +331,59 @@ only. | |||||
|
|
||||||
| [Learn more about VPN provider detection on our Knowledge Base.](https://support.maxmind.com/knowledge-base/articles/anonymizer-and-proxy-data-maxmind) | ||||||
| {{</ geoip-schema-row >}} | ||||||
|
|
||||||
| {{< geoip-schema-row key="residential" valueType="object" insights="true">}} | ||||||
| This object contains data about the residential proxy network associated | ||||||
| with the IP address. | ||||||
|
|
||||||
| See the [Anonymizer > Residential](#schema--response--anonymizer--residential) | ||||||
| section below for details. | ||||||
| {{</ geoip-schema-row >}} | ||||||
| {{</ schema-table >}} | ||||||
|
|
||||||
| <!-- prettier-ignore-end --> | ||||||
|
|
||||||
| ### Anonymizer > Residential | ||||||
|
|
||||||
| {{< anchor-target schema--response--anonymizer--residential >}} | ||||||
|
|
||||||
| `residential` is a JSON object that contains data about the residential proxy | ||||||
| network associated with the IP address. This data is available for GeoIP | ||||||
| Insights only. | ||||||
|
|
||||||
| The `residential` object may be present even when none of the other | ||||||
| `anonymizer` fields are populated. | ||||||
|
|
||||||
| ```json | ||||||
| { | ||||||
| "confidence": 82, | ||||||
| "network_last_seen": "2026-05-11", | ||||||
| "provider_name": "quickshift" | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| <!-- prettier-ignore-start --> | ||||||
|
|
||||||
| {{< schema-table key="anonymizer--residential" >}} | ||||||
| {{< geoip-schema-row key="confidence" valueType="integer" valueTypeNote="min: 1, max: 99" insights="true">}} | ||||||
| A score ranging from 1 to 99 that represents our percent confidence that the network is an actively used residential proxy. | ||||||
|
|
||||||
| [Learn more about anonymizer confidence on our Knowledge Base.](https://support.maxmind.com/knowledge-base/articles/anonymizer-and-proxy-data-maxmind) | ||||||
| {{</ geoip-schema-row >}} | ||||||
|
|
||||||
| {{< geoip-schema-row key="network_last_seen" valueType="string" insights="true">}} | ||||||
| The last day that the network was sighted in our analysis of residential proxies. This is in the ISO 8601 date format (YYYY-MM-DD). | ||||||
|
|
||||||
| [Learn more about anonymizer and proxy detection on our Knowledge Base.](https://support.maxmind.com/knowledge-base/articles/anonymizer-and-proxy-data-maxmind) | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. When a sentence ends with a Markdown link, the period should be placed outside the link brackets and parentheses, not inside the link text.
Suggested change
References
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Claude, on behalf of Greg: Keeping the period inside the link — that placement is this file's existing convention (30+ occurrences throughout responses.md), so changing only the new lines would make them inconsistent with the surrounding document. |
||||||
| {{</ geoip-schema-row >}} | ||||||
|
|
||||||
| {{< geoip-schema-row key="provider_name" valueType="string" insights="true">}} | ||||||
| The name of the residential proxy provider (e.g., `oxylabs`, `smartproxy`) associated with the network. | ||||||
|
|
||||||
| Please note that MaxMind identifies a subset of residential proxy providers. A current list of identified providers is available on request. | ||||||
|
|
||||||
| [Learn more about residential proxy provider detection on our Knowledge Base.](https://support.maxmind.com/knowledge-base/articles/anonymizer-and-proxy-data-maxmind) | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. When a sentence ends with a Markdown link, the period should be placed outside the link brackets and parentheses, not inside the link text.
Suggested change
References
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Claude, on behalf of Greg: Keeping the period inside the link — that placement is this file's existing convention (30+ occurrences throughout responses.md), so changing only the new lines would make them inconsistent with the surrounding document. |
||||||
| {{</ geoip-schema-row >}} | ||||||
| {{</ schema-table >}} | ||||||
|
|
||||||
| <!-- prettier-ignore-end --> | ||||||
|
|
@@ -1405,7 +1466,12 @@ request. | |||||
| "is_residential_proxy": true, | ||||||
| "is_tor_exit_node": true, | ||||||
| "network_last_seen": "2025-01-15", | ||||||
| "provider_name": "nordvpn" | ||||||
| "provider_name": "nordvpn", | ||||||
| "residential": { | ||||||
| "confidence": 82, | ||||||
| "network_last_seen": "2026-05-11", | ||||||
| "provider_name": "quickshift" | ||||||
| } | ||||||
| }, | ||||||
| "traits": { | ||||||
| "ip_address": "1.2.3.4", | ||||||
|
|
||||||
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When a sentence ends with a Markdown link, the period should be placed outside the link brackets and parentheses, not inside the link text.
References
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Claude, on behalf of Greg: Keeping the period inside the link — that placement is this file's existing convention (30+ occurrences throughout responses.md), so changing only the new lines would make them inconsistent with the surrounding document.