PHPackages                             sdksio/usps-apimatic-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. sdksio/usps-apimatic-sdk

ActiveLibrary[API Development](/categories/api)

sdksio/usps-apimatic-sdk
========================

APIMatic SDK for USPS API

1.0.0(1mo ago)01MITPHPPHP ^7.2 || ^8.0

Since Apr 29Pushed 1mo agoCompare

[ Source](https://github.com/apimatic/usps-apimatic-php-sdk)[ Packagist](https://packagist.org/packages/sdksio/usps-apimatic-sdk)[ Docs](https://apimatic.io/)[ RSS](/packages/sdksio-usps-apimatic-sdk/feed)WikiDiscussions main Synced 1w ago

READMEChangelogDependencies (5)Versions (2)Used By (0)

Getting Started with USPS API
=============================

[](#getting-started-with-usps-api)

Introduction
------------

[](#introduction)

Contact Us: [USPS API Support](https://emailus.usps.com/s/usps-APIs) | [Terms of Service](https://about.usps.com/termsofuse.htm)

The Addresses API validates and corrects address information to improve package delivery service and pricing. This suite of APIs provides different utilities for addressing components. The ZIP Code™ lookup finds valid ZIP Code™(s) for a City and State. The City/State lookup provides the valid cities and states for a provided ZIP Code™. The Address Standardization API validates and standardizes USPS® domestic addresses, city and state names, and ZIP Code™ in accordance with USPS® addressing standards. The USPS® address standard includes the ZIP + 4®, signifying a USPS® delivery point, given a street address, a city and a state.

Install the Package
-------------------

[](#install-the-package)

Run the following command to install the package and automatically add the dependency to your composer.json file:

```
composer require "sdksio/usps-apimatic-sdk:1.0.0"
```

Or add it to the composer.json file manually as given below:

```
"require": {
    "sdksio/usps-apimatic-sdk": "1.0.0"
}
```

You can also view the package at:

Initialize the API Client
-------------------------

[](#initialize-the-api-client)

***Note:*** Documentation for the client can be found [here.](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/doc/client.md)

The following parameters are configurable for the API Client:

ParameterTypeDescriptionenvironment[`Environment`](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/README.md#environments)The API environment.
 **Default: `Environment.PRODUCTION`**timeout`int`Timeout for API calls in seconds.
*Default*: `30`enableRetries`bool`Whether to enable retries and backoff feature.
*Default*: `false`numberOfRetries`int`The number of retries to make.
*Default*: `0`retryInterval`float`The retry time interval between the endpoint calls.
*Default*: `1`backOffFactor`float`Exponential backoff factor to increase interval between retries.
*Default*: `2`maximumRetryWaitTime`int`The maximum wait time in seconds for overall retrying requests.
*Default*: `0`retryOnTimeout`bool`Whether to retry on request timeout.
*Default*: `true`httpStatusCodesToRetry`array`Http status codes to retry against.
*Default*: `408, 413, 429, 500, 502, 503, 504, 521, 522, 524`httpMethodsToRetry`array`Http methods to retry against.
*Default*: `'GET', 'PUT'`loggingConfiguration[`LoggingConfigurationBuilder`](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/doc/logging-configuration-builder.md)Represents the logging configurations for API callsproxyConfiguration[`ProxyConfigurationBuilder`](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/doc/proxy-configuration-builder.md)Represents the proxy configurations for API callsoauthAuthorizationCodeCredentials[`OauthAuthorizationCodeCredentials`](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/doc/auth/oauth-2-authorization-code-grant.md)The Credentials Setter for OAuth 2 Authorization Code GrantoauthClientCredentialsCredentials[`OauthClientCredentialsCredentials`](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md)The Credentials Setter for OAuth 2 Client Credentials GrantbasicAuthCredentials[`BasicAuthCredentials`](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/doc/auth/basic-authentication.md)The Credentials Setter for Basic AuthenticationbearerTokenAuthCredentials[`BearerTokenAuthCredentials`](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/doc/auth/oauth-2-bearer-token.md)The Credentials Setter for OAuth 2 Bearer tokenThe API client can be initialized as follows:

```
use UspsApiLib\Logging\LoggingConfigurationBuilder;
use UspsApiLib\Logging\RequestLoggingConfigurationBuilder;
use UspsApiLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use UspsApiLib\Environment;
use UspsApiLib\Authentication\OauthAuthorizationCodeCredentialsBuilder;
use UspsApiLib\Models\OauthScopeOauthAuthorizationCode;
use UspsApiLib\Authentication\OauthClientCredentialsCredentialsBuilder;
use UspsApiLib\Models\OauthScopeOauthClientCredentials;
use UspsApiLib\Authentication\BasicAuthCredentialsBuilder;
use UspsApiLib\Authentication\BearerTokenAuthCredentialsBuilder;
use UspsApiLib\UspsApiClientBuilder;

$client = UspsApiClientBuilder::init()
    ->oauthAuthorizationCodeCredentials(
        OauthAuthorizationCodeCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret',
            'OAuthRedirectUri'
        )
            ->oauthScopes(
                [
                    OauthScopeOauthAuthorizationCode::ADDRESSES,
                    OauthScopeOauthAuthorizationCode::ADJUSTMENTS
                ]
            )
    )
    ->oauthClientCredentialsCredentials(
        OauthClientCredentialsCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
            ->oauthScopes(
                [
                    OauthScopeOauthClientCredentials::ADDRESSES,
                    OauthScopeOauthClientCredentials::ADJUSTMENTS
                ]
            )
    )
    ->basicAuthCredentials(
        BasicAuthCredentialsBuilder::init(
            'Username',
            'Password'
        )
    )
    ->bearerTokenAuthCredentials(
        BearerTokenAuthCredentialsBuilder::init(
            'AccessToken'
        )
    )
    ->environment(Environment::PRODUCTION)
    ->loggingConfiguration(
        LoggingConfigurationBuilder::init()
            ->level(LogLevel::INFO)
            ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
            ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
    )
    ->build();
```

Environments
------------

[](#environments)

The SDK can be configured to use a different environment for making API calls. Available environments are:

### Fields

[](#fields)

NameDescriptionPRODUCTION**Default**TESTING-Authorization
-------------

[](#authorization)

This API uses the following authentication schemes.

- [`OAuth_authorization_code (OAuth 2 Authorization Code Grant)`](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/doc/auth/oauth-2-authorization-code-grant.md)
- [`OAuth_client_credentials (OAuth 2 Client Credentials Grant)`](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md)
- [`BasicAuth (Basic Authentication)`](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/doc/auth/basic-authentication.md)
- [`BearerTokenAuth (OAuth 2 Bearer token)`](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/doc/auth/oauth-2-bearer-token.md)

List of APIs
------------

[](#list-of-apis)

- [Listener URL Specification](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/doc/controllers/listener-url-specification.md)
- [Resources](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/doc/controllers/resources.md)
- [Files](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/doc/controllers/files.md)

SDK Infrastructure
------------------

[](#sdk-infrastructure)

### Configuration

[](#configuration)

- [ProxyConfigurationBuilder](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/doc/proxy-configuration-builder.md)
- [LoggingConfigurationBuilder](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/doc/logging-configuration-builder.md)
- [RequestLoggingConfigurationBuilder](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/doc/request-logging-configuration-builder.md)
- [ResponseLoggingConfigurationBuilder](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/doc/response-logging-configuration-builder.md)

### HTTP

[](#http)

- [HttpRequest](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/doc/http-request.md)

### Utilities

[](#utilities)

- [ApiResponse](https://www.github.com/apimatic/usps-apimatic-php-sdk/tree/1.0.0/doc/api-response.md)

###  Health Score

36

—

LowBetter than 79% of packages

Maintenance91

Actively maintained with recent releases

Popularity2

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity38

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

42d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/ef06f97b4ff5db714f2a124525216538f97338487cd4e2bca22baa32c0bf90cd?d=identicon)[developer-sdksio](/maintainers/developer-sdksio)

---

Top Contributors

[![aliraza1231](https://avatars.githubusercontent.com/u/77957290?v=4)](https://github.com/aliraza1231 "aliraza1231 (1 commits)")

---

Tags

sdkapimaticusps

###  Code Quality

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/sdksio-usps-apimatic-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/sdksio-usps-apimatic-sdk/health.svg)](https://phpackages.com/packages/sdksio-usps-apimatic-sdk)
```

###  Alternatives

[square/square

Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.

753.7M26](/packages/square-square)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)