Mr. Mail Tracker API Documentation



Test Account

If your company has an active subscription, you may use the credentials from that account for testing and development with the API. Email us at info@mrmailtracker.com to get an API key. In this case, you'll be testing with live actual tracking data from your account.

If you do not have an active subscription, a testing account is available for developers to use when building applications that use the Mr Mail Tracker API. This test account will allow access to dummy data that you can use for testing.
user_id: 20
login_id: 49
key: GsF6CkPmErRh

Requests

Requests to the API are sent as an HTTP GET request. Data is served back to the client as JSON.

Each request uses a specific path in the url. The type of data being requested determines which path to use.
For example, the request for a list of mailings in the system is sent to:
https://MrMailTracker.com/api/mailings
The request for details about a particular mailing is sent to:
https://MrMailTracker.com/api/track_mailing

The specifics of the request are added to the url in a query string. Here is an example of a full url to request a list of mailings in the system:
https://MrMailTracker.com/api/mailings?login_id=11&user_id=12&search_string=null&key=GsF6CkPmErRh&search_field=null

Contents

/api/mailings
Get a list of mailings that are in the tracking system.
/api/track_mailing
Provides the delivery specs for a specific mailing.
/api/track_mailing_state
Provides the delivery specs for a mailing, broken down by state.
/api/track_mailing_city
Provides the delivery specs for a mailing, broken down by city.
/api/track_mailing_zip
Provides the delivery specs for a mailing, broken down by ZIP code.
/api/track_mail_piece
Provides all the scan details for a particular mail piece.
/api/scans
Provides the raw tracking scan information from the USPS for a particular mailing.
/api/process_geocodes
Populates the database with the map coordinates for the cities and ZIP codes of a particular mailing.