Skip to content
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

feat: quick addition of 'cur' and 'short' options #7

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

pz1k
Copy link

@pz1k pz1k commented Nov 14, 2024

Allow the usage of

  • cur?: 0 | 1;

When the asn flag is enabled you'll receive a currency result by default, you can choose to disable this by supplying &cur=0, please note that &cur=1 will not activate the currency display unless &asn=1 is also supplied.

  • short?: 0 | 1;

When the short flag is set to 1 we will compress the result, placing the IP address you're testing in the same array as the results instead of a sub-array under the IP address heading. This can make the API easier to parse in some languages but will lock you into only checking a single address per individual request.

Descriptions from the official api - https://proxycheck.io/api/

| {
[ipAddress: string]: IPAddressInfo
}
| IPAddressInfo
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you confirm if the addition of type IPAddressInfo breaks existing versions?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants