v1

latestSwagger 2.02026-07-1798126172.4 KB

Proposal

Returns proposals

Returns list of proposals filtered by provider id

get/proposals

Query parameters

provider_idstring

id of provider proposals

service_typestring

the service type of the proposal. Possible values are "openvpn", "wireguard" and "noop"

access_policystring

the access policy id to filter the proposals by

access_policy_sourcestring

the access policy source to filter the proposals by

countrystring

If given will filter proposals by node location country.

ip_typestring

IP Type (residential, datacenter, etc.).

compatibility_mininteger

Minimum compatibility level of the proposal.

compatibility_maxinteger

Maximum compatibility level of the proposal.

quality_minnumber

Minimum quality of the provider.

nat_compatibilitystring

Pick nodes compatible with NAT of specified type. Specify "auto" to probe NAT.

Response

List of proposals

Example response

{
  "proposals": [
    {
      "location": {
        "asn": 1,
        "city": "Amsterdam",
        "continent": "EU",
        "country": "NL",
        "ip_type": "residential",
        "isp": "Telia Lietuva, AB"
      },
      "provider_id": "0x0000000000000000000000000000000000000001",
      "service_type": "openvpn"
    }
  ]
}