Wiki

Case Status
Log In

Wiki

 
List of API Calls»API Call - Country - List Port…
  • RSS Feed

Last modified on 8/18/2017 1:53 PM by User.

Tags:

API Call - Country - List Ports

Description:

This call is designed to produce a list of ports within a country based on an input of a country's location code (locode).

Parameters: Value
locode The country's unique locode.
format json, xml, html

Call Format:

/api/country/<locode>/ports.<format>

Example:

Input: http://www.findaport.com/api/country/es/ports.xml
Output: An XML output listing all the ports in Spain (where "es" is the country code for Spain).

Output Fields:

Output Fields Descriptions Examples
piuid Port identifier 32
port Port name Aguilas
locode Country UN/LOCODE  ES
type Type of entry Port
port_lvl Port level 5
locale_id Locale identifier (region within country) 557
unctad_port_code   AGU
symbol_id Port image symbol ID
See Reference Data for a file of port symbol images
787
lat Latitude of port 37.4
lng Longitude of port -1.5833
parent_id PIUID of the port which contains the information about this port, if any. 32
web Web address  
has_detail Whether port has detailed information (True|False). 1
has_summary Whether port has summary information (True|False) 1
plans_count Number of plans and photos available. 1
wx_id Weather identifier (not used) 4010
wx_name Name of nearest location where the weather information is available, when it is not available for the port location itself.

 

version Latest version of the port information for this port 66066

Output example:

Example Output

Previous API Call: Country - List Locales        Next API Call: Country - View Country                             Return to API Call Summary


Need an API Key? Click here here for more details.

 

If you would like to find out more about Findaport.com or our Findaport API service, please contact us at info@portinfo.co.uk. Shipping Guides Ltd are recognised industry specialists in publishing port and harbour information for your various port entry requirements. For more information on our products, please visit www.portinfo.co.uk.