Get started

gSuite is the bundle of APIs GEOSPAN offers for fast, detailed geospatial information on structures, such as building roofs. These geospatial APIs allow the user to geoprocess a location: enabling the location to be accurately described and analyzed within a geographic information system (GIS).

The GEOSPAN API allows you to transmit that geospatial information from GEOSPAN to your data sources and users.

Before you begin: Account, API key, and Quota

Before you can successfully call the GEOSPAN API, you need an account, an API key, and some quota. As an individual GEOSPAN user, the process is familiar. If you are part of an organization, account, key, and quota are provisioned differently than if you are a sole GEOSPAN user. For more information on GEOSPAN accounts, see Your Account in the Support Knowledge Base.

Step Individual GEOSPAN User Part of an Organization
Get an account Sign up for an account. At geospan.com, select the Sign-Up button. Request an invite from the GEOSPAN account owner in your organization.
Get an API key After you have an account, generate an API key. Request an API Key from the GEOSPAN account owner in your organization.
Get quota Add to your quota with a credit card or promotional code. Confirm with your organization’s GEOSPAN account owner that quota exists for API calls.

Overview of GEOSPAN tools for end-users

While you are getting started on the APIs, it may be helpful to understand how the end-user interacts with GEOSPAN technology. End-users have the following interfaces:

  • To order a gSquare instant estimate, the user enters an address and selects the structure from the interactive map.
  • To order a gPro drawing, the user enters an address, selects the building, and provides additional information.
  • View the detailed gPro drawing of a previous order. The user can select from Orders>Complete and be directed to a URL https://apps.geospan.com/gsuite/orders/<order number>/job/<job number>.

Overview of developer interfaces

As a developer, you have access to the following gSuite APIs:

  • gSquare: GEOSPAN’s instant estimation API
  • gPro: GEOSPAN’s modeling APIs for ordering and retrieving structural drawings
  • Spatial: GIS APIs to assist building apps with gSquare and gPro
  • Webhooks: Get real-time notifications of events occurring in the GEOSPAN system

Authorization: Api-Key

GEOSPAN REST API is designed to work with API keys in the Authorization header. When calling any GEOSPAN APIs use that API key in the Authorization header with a bearer string of Api-key.

​
headers = {
    "Authorization": f"Api-key {GEOSPAN_API_KEY}",
}

res = requests.get(..., headers=headers)
fetch(..., {
    headers: {
        "Authorization": `Api-key ${GEOSPAN_API_KEY}`,
    },
});
curl -X 'GET' \
  'https://api.geospan.com/remote4d/v1/api/...' \
  -H 'accept: application/json' \
  -H 'Authorization: Api-key <geospanapikeystring>'

Additional concepts

You should be all set to work with the GEOSPAN API. Additional concepts, especially around Geospatial and geoprocessing specifications and conventions can be found at Concepts.