API Reference Guides
Click the link below to access the documentation for the associated API. Each API Reference Guide includes details about each of the API calls, request parameters, response examples, and related data dictionary data types and response attributes.
Address Autocomplete API Reference Guide
Use this API to search the database using a partial address. The resulting return is a list of parsed, autocompleted USPS addresses that match the search criteria provided.
Address Validation API Reference Guide
Use this API to validate a complete USPS address inclusive of a secondary address line (IE Apt, Ste, FL) and to obtain more detailed information about the address location.
Advanced CPQ API Reference Guides (v1 and v2)
Use this set of APIS to create deals, configure pricing requirements, and return quotes for locations.
Building Competitive Rating API Reference Guide
Use this API to retrieve the competitive rating for a location. Competitive Ratings data helps you to better understand the competitive landscape and more effectively price services.
Connected World Availability API Reference Guide
Use this set of APIs to share information with your partner(s) about the buildings and the products and services you offer at those buildings.
Connected World Building API Reference Guide
Use this set of APIs to create, retrieve, update, or remove buildings or building attributes to/from your instance.
Connected World Account API Reference Guide
Use this API to retrieve your company’s Connectbase account information.
Connected World Building Lists API Reference Guide
Use this set of APIs to retrieve building list data in your instance.
Connected World Contacts API Reference Guide
Use this set of APIs to add, retrieve or update contact information in your instance.
Connected World Distributions API Reference Guide
Use this set of APIs to create, get, initiate, or update a distribution.
CPQ API Reference Guide
Use this set of APIs to create deals, configure pricing requirements, and return quotes for locations.
Note: Connectbase recommends using the Advanced CPQ APIs in place of the standard CPQ APIs for improved results. The Advanced CPQ is the next gen set of APIs for configuring and retrieving pricing and quotes
CPQ Components API Reference Guide
Use this set of APIs to set up “reusable” pricing groups for use in a CPQ quote under the configured conditions.
Demand Engine API Reference Guide
Use this set of APIs to programmatically extract analytics from the Connectbase Demand Engine.
Geocode API Reference Guide
Use this API to pass a location in a request body that will return the latitude and longitude of the given location. The response also indicates an accuracy rating and accuracy type.
International Address Validation API Reference Guide
Use this API for address validation and formatting of international addresses.
Location Intelligence API Reference Guide
Use this API to retrieve census block information using latitude and longitude search.
Network Intelligence API Reference Guide
Use this set of APIs to get network information based on a specific address, such as broadband, cableco, nearnet, onnet, telco, wisp, etc.
Network Path API Reference Guide
Use this set of APIs to submit an A and Z location that returns a geojson-formatted response for those two endpoints, inclusive of all paths or a specific company path.
It will assign a Segment ID, calculate distance and latency, and present that information in the response in addition to the geojson data. There is also a secondary endpoint which allows for two different segment ids to be compared and determines if they are diverse from one other.
NNI Management API Reference Guide
Use this set of APIs create, delete, or retrieve NNI locations.
Rate Card API Reference Guide
Use this set of APIs to manage your rate cards.
Shareable Routes - Route Management API Reference Guide
Use this API to retrieve route information from The Connected World platform’s US Shareable Routes and International Shareable Routes data points.
The response provides the fiber routes within a radius given as a value (siteDistance) as well as the provider of those routes.
Tenant API Reference Guide
Use this API to retrieve a list of tenants for a specific company, based on building Id.