List of API Calls

Table of Contents

1. Introduction to API Calls
   1. Call Format
   2. API Calls
   3. Try the API Calls yourself

Introduction to API Calls

Call Format

Each article here shows the format required to construct a valid API call. Taking viewing a port summary as an example, the format of the API call is shown as:

/api/port/<port_id>/summary.<format>?key=<APIkey>

where <  > represents the parameters required for the API call. In this specific case, these are:

• the port ID
• the format of the output
• the APIKey

If the API key is abcdefg12345, and you would like to display the port summary for Algiers (port ID = 65) in HTML format, the API call will be:

    https://www.findaport.com/api/port/65/summary.html?key=abcdefg12345

This convention is used for all the API calls documented here. For more information, see API Call Format Description

API Calls

The API Calls available include:

• Country
  • List countries
  • List states/provinces/regions in a  country
  • Display country information
  • List ports in country
• Locale
  • List all locales
• Port
  • Search
  • Table of Contents
  • View
  • Summary
  • Information
  • Port Section
    • Section List
    • Section content
  • Plans
    • Plan List
    • Plan
  • ACE Reports
    • ACE Report List
    • ACE Report
  • Version Management
    • Version
    • Update List
• Weather
  • Weather Report
• News
  • News Item
• Submissions
  • ACE Report
  • Errata

Try the API Calls yourself

All the API Call examples in the API Call documentation are clickable. Just provide your API Key when you execute the API call in the browser window to see the output.

Next API Call: Country - List Countries                                                                                                                     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 portinformation@oneocean.com.