pypply makes it easier to use Upply API by providing a simple, well-structured Python interface for retrieving benchmark rates, UFI data, and geographic information. With quick and straightforward integration — just like the Upply API — you can get up and running in minutes. It handles API connections, payload processing, and error management so you can focus on building your application.

Features

pypply supports all of the features of the Upply API, and additional ones to make life easier for developers. For details on the capabilities, you are encouraged to review the Upply API documentation.

Global

Payload Processing : Automatically merge and complete client-provided payloads with default values, reducing boilerplate code and ensuring consistency in your API requests.

Data validation : Validate payload structure and input parameters using Pydantic models. This ensures that data sent to the API meets expected formats and types.

Error Handling : Robust error handling with meaningful error messages and logging. This makes debugging easier and ensures that issues are reported clearly to the user.

Products

Geography

Geocoding: Convert a location query (such as a city, airport, or seaport) into its corresponding latitude and longitude.
Seamless Integration: Integrates with benchmark payload processing so that users do not have to supply coordinates manually.

Benchmark

Benchmark Rates: Easily retrieve lane benchmark rates for various transport modes (air, road_emea, road_na, sea_longterm) along with their associated rates.
Confidence Index: Obtain a confidence index indicating the reliability of the benchmark result.
Emissions: Retrieve emissions data (e.g., CO₂, SO₂, NOx, etc.) as part of the benchmark response.
Default Payload Support: Use built-in default payloads so that you don’t have to specify every parameter manually.
Geolocation Integration: Benchmark requests can automatically fetch latitude and longitude data, eliminating the need for users to provide coordinates explicitly.

UFI

List Available UFIs: Easily list and filter available UFIs by transport mode, market, and name.
Historical Data: Retrieve historical UFI data for specified periods with flexible filtering options such as date ranges and number of months.
Forecast Data: Retrieve short-term forecast rates with a configurable number of forecast weeks.
Full UFI Rates: Combine historical and forecast data into a single, comprehensive view.
Multiple UFI Support: Easily retrieve full data for multiple UFIs by filtering based on transport mode, market, and name.

Installation

Install or upgrade pypply with:

pip install pypply --upgrade

You can also obtain the source code from the pypply GitHub repository.

Authentication

Authentication allows you to connect a user’s Upply account to your internal app or a third party app. This process involves providing your app with a token that’s generated by Upply. If you don’t already have one, please see https://developers.upply.com/docs/token-generation.