Get Optimized Server

Estimated reading: 6 minutes

Optimizing VPN server selection is crucial for ensuring the best possible performance and user experience. By leveraging APIs, users can dynamically find and connect to the most suitable VPN servers based on various factors such as latency, load, and geographical location. This article provides a technical overview of how to retrieve an optimized VPN server via API for a better VPN connection.

Overview

Retrieving an optimized VPN server via API involves sending a request to an endpoint designed to assess and return the best available server based on current conditions. This operation helps users and administrators select a server that provides optimal performance, minimizing latency and improving connection stability.

URL: <base url>/speedtest/v4/serversWithoutPsk
Request Method: POST

Payload

Key	Type	Pass in	Description
`X-AccessToken`*	String	Header	`accessToken` retrieved from Get Access Token endpoint
`sCountrySlug`*	String	Body	`countries.iso_code` retrieved from Get Subscribed Countries endpoint
`iCityId`	Integer	Body	`cities.id` retrieved from Get Subscribed Cities endpoint
`iResellerId`*	Integer	Body	`resellerId` retrieved from Get Access Token endpoint
`sProtocolSlug1`*	String	Body	`protocols.protocol` retrieved from Get Subscribed Protocols endpoint
`sProtocolSlug2`	String	Body	`protocols.protocol` retrieved from Get Subscribed Protocols endpoint
`sProtocolSlug3`	String	Body	`protocols.protocol` retrieved from Get Subscribed Protocols endpoint
`sUsername`*	String	Body	VPN Username of the user requesting connection
`sDeviceType`*	String	String	Type of device Possible values: android \| ios \| mac \| windows
`iChannelId`	String	String	`channels.id` retrieved from Get Subscribed Channels endpoint
`iMultiPort`	Integer	Body	0 for getting multiport servers (0/1)
`sDataCenters`	json	Body	Json array of datacenters [123,122]
`iNatting`	Integer	Body	1 for returning non-natted servers, 2 for natted
`aServerFilter`	Json	Body	Exclude servers from server selection logic Sample JSON: [ { 'nasidentifier' : 'lux-01-01-01','type' : 'include \| exclude'} ]
`aTagsFilter`	Json	Body	Exclude tags from server selection logic Sample [“TAG_RAM_BASED”, TAG_OVPN_OBF]
`sClientPublicKey`	String	Body	Clients device public key *Mandatory if WireGuard protocol is requested

(*) Required Parameter

Response

Key	Type	Description
`header`	Object	Contains Object describing error code and error messages
`body`	Array	Object containing servers
`servers`	Array	array of servers containing keys mentioned below
`host`	String	Host name of the server to be dialed
`hub_key`	String	Hub key the password required for connection in case of stealthvpn
`acknowledgement_server`	String	Host of the acknowledgement server
`port_number`	String	Port number to be pinged for checking servers availability
`protocol_no`	Integer	Protocol number Requested
`destination_country`	Integer	Id of the destination country
`server_type`	String	Type of server (windows/linux)
`speedtest_method`	String	Calculation method against which the server is returned. Dc is for Datacenter, LL is for Latitude/Longitude, FO is for failover and AFO is for advance feature failovers . (DC/LL/FO/AFO)
`filter_success`	Integer	0 or 1 Indicated either the provided json of server filter applied to result or not
`ram_based`	Integer	0 or 1 Indicated that return server is ram based or not
`ovpn_obf`	Integer	0 or 1 Indicates that return server supports ovpn obfuscation
`ip_translation`	Integer	0 or 1 Integer 0 or 1 Indicates that return server is natted or non-natted 0=non-natted,1=natted
`nasidentifer`	String	Server’s Name
`iperf_client_ip`	String	Iperf client ip
`iperf_port_range`	String	Iperf port range
`iperf_client_status`	String	Iperf client status
`configuration_version`	String	OVPN configuration version
`configuration`	String	OVPN configuration
`is_experiment_server`	Integer	0 or 1 Indicates that either the returned server belongs to experiment cohort
`wireguard_configuration`	String	Configuration required for wireguard connection

Possible API error codes

Code	Message	Description
`1001`	Invalid Device Type Provided !	Provided device type is invalid.
`1002`	Reseller id provided is either Invalid or Expired !	Reseller has expired or is invalid .
`1003`	Country Not Allowed !	Reseller not allowed connection to the requested country
`1004`	City Not Allowed !	Reseller not allowed connection to the requested city
`40001`	Protocol is either not available or not allowed, please try again later or switch to other protocol!	Reseller not allowed connection to the requested protocol
`40002`	Advance Features Not Allowed !	Reseller not allowed connection with requested advance features
`1007`	Failed to Validate Connection Request !	Some error occurred while validating reseller's inventory.
`1008`	Sorry! Your Multi Login Limit has Exceeded	The user has exceeded the allowed number of concurrent sessions for the day. Disconnect an active session and try again.
`1009`	Session Limit for User Exceeded !	Allowed sessions per day exceeded by user. Renews 24 hrs.
`1010`	Unable to generate Psk!	Some error occurred while generating psk.
`1011`	Something went wrong, inserting data!	Some error occurred while generating psk.
`1012`	Invalid Reseller Id Provided !	Invalid Reseller Id Provided
`1013`	Invalid Country Id Provided !	Invalid Country Id Provided
`1014`	Invalid Protocol No Provided !	Invalid Protocol No Provided
`1015`	Invalid Ip Address Provided !	Invalid clients ip address provided
`1016`	Invalid Username Provided !	Invalid Username Provided
`1017`	Invalid Channel Id Provided !	Invalid Channel Id Provided
`1032`	All NAT Servers are busy, please try again later or switch to other network type !	All NAT Servers are busy, please try again later or switch to other network type
`1031`	No Servers Found !	No Servers Found with provided params.
`1050`	Invalid Params !	One of the Required Params are not provided.
`1051`	Username Not found !	The provided username does not exists
`5002`	invalid service Keys	Provided advance features slugs are invalid
`5004`	User not found	Provided username not found in system
`5006`	Country not found in user inventory	Provided country not found in users inventory
`5007`	Protocol not found in user inventory	Provided Protocol not found in users inventory
`5008`	Invalid protocol number provided	Provided protocol number is invalid
`10007`	Your account has expired. Buy premium account and enjoy unlimited freedom	Incase VPN account has been expired
`10008`	Your account has been disabled, please contact our 24x7 live chat support for more details	Provided VPN account is disabled
`1009`	Reseller not found	Provided reseller id not found
`1052`	Channel belongs to country which is not allowed to reseller	Channel belongs to country which is not allowed to reseller
`40007`	Invalid Tag Provided!	Tags provided in aTag params are not valid
`40008`	All Ram based servers are busy, please try again later or switch to other network type!!	No ram based server is available is requested destination
`1036`	failed to upload client public key	Wireguard middleware failed to upload client’s public key
`1035`	No response from WireGuard Server	No wireguard server is available against provided params
`40003`	password is invalid	Given password is invalid
`40004`	Unable to connect with WireGuard Server!	Wireguard server failed to respond
`40005`	sPassword, sClientPublicKey & sSdkVersion is mandatory when WireGuard protocol is requested!	Not all Parameters are provided
`40006`	WireGuard protocol is not allowed on this endpoint!	If someone provide wireguard protocol to old endpoints of speedtest

Sample Response

{
  "header": {
    "code": 1,
    "message": "Success"
  },
  "body": {
    "servers": [{
      "host": "xxxxxx.pointtoserver.com",
      "hub_key": "",
      "acknowledgement_server": "xxxxxx.pointtoserver.com",
      "port_number": "30",
      "protocol_no": 8,
      "country": "US",
      "multiport": 0,
      "server_type": "linux",
      "speedtest_method": "DC"
      "filter_success": false
      "ram_based": 0
      "ovpn_obf": 0
      "ip_translation": 1
      "nasidentifer": "lux-01-xx-xx",
      "iperf_client_ip": "...........com",
      "iperf_port_range": "5201:5210",
      "iperf_client_status": 0,
      "configuration_version": "",
      "configuration": "", 
      "Wireguard_configuration" : "",
      "Is_experiment_server" : ""
    }]
  }
}