Documentation

 

Local API Installations

If your company has strict policies in place that prevent you from calling cloud-based web services on the internet (such as ours), you may want to consider becoming an enterprise customer, allowing you to run your own local installation of our APIs. This document details some of the prerequisites for doing this and provides links to each API's specific installation process.

Contents

  1. API Documentation
  2. Updates
  3. Requirements
  4. API Listing

API Documentation

All local installations of the SmartyStreets APIs perform identically to the cloud-based versions hosted by SmartyStreets with the exception that they don't require client authentication or authorization. Please refer to the documentation for each specific API for details about input and output fields.

Updates

SmartyStreets publishes regular updates to local API packages. New releases are announced in our open-source Changelog repository.

Minimum System Requirements

The process of downloading, installing, and managing a local instance of any SmartyStreets API requires a system administrator or software engineer who has experience with the Linux operating system and its accompanying shell environment.

The server provisioned to run a local API instance should have at least 1+ gigabyte of RAM, multiple CPU cores, and an up-to-date version of Linux. For specific requirements, see the API listing below. Responsibility for network and server maintenance (as well as the performance of all installation instructions) rests with your organization.

API Listing

Installation instructions and minimum system requirements:

This site uses cookies for analytics, personalized content, and ads. By continuing to browse this site, you agree to this use.
Consuming raw or undercooked cookie dough may increase your risk of foodborne illness.