Solar API (solar:v1)

Additions

Methods


• ▼ ▲ solar.geoTiff.get

  Description: Returns an image by its ID.

  Parameters:

  id

  Type: string

  Location: query

  Description: Required. The ID of the asset being requested.

  Scopes: https://www.googleapis.com/auth/cloud-platform

  HTTP Method: GET

  Flat Path: v1/geoTiff:get

  Path: v1/geoTiff:get

• ▼ ▲ solar.dataLayers.get

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Path: v1/dataLayers:get

  Flat Path: v1/dataLayers:get

  HTTP Method: GET

  Parameters:

  pixelSizeMeters

  Format: float

  Type: number

  Description: Optional. The minimum scale, in meters per pixel, of the data to return. Values of 0.1 (the default, if this field is not set explicitly), 0.25, 0.5, and 1.0 are supported. Imagery components whose normal resolution is less than `pixel_size_meters` will be returned at the resolution specified by `pixel_size_meters`; imagery components whose normal resolution is equal to or greater than `pixel_size_meters` will be returned at that normal resolution.

  Location: query

  view

  Location: query

  Type: string

  Description: Optional. The desired subset of the data to return.

  Enum:

  • DATA_LAYER_VIEW_UNSPECIFIED
  • DSM_LAYER
  • IMAGERY_LAYERS
  • IMAGERY_AND_ANNUAL_FLUX_LAYERS
  • IMAGERY_AND_ALL_FLUX_LAYERS
  • FULL_LAYERS

  Enum Descriptions:

  • Equivalent to FULL.
  • Get the DSM only.
  • Get the DSM, RGB, and mask.
  • Get the DSM, RGB, mask, and annual flux.
  • Get the DSM, RGB, mask, annual flux, and monthly flux.
  • Get all data.

  radiusMeters

  Description: Required. The radius, in meters, defining the region surrounding that centre point for which data should be returned. The limitations on this value are: * Any value up to 100m can always be specified. * Values over 100m can be specified, as long as `radius_meters` <= `pixel_size_meters * 1000`. * However, for values over 175m, the `DataLayerView` in the request must not include monthly flux or hourly shade.

  Format: float

  Type: number

  Location: query

  location.latitude

  Location: query

  Description: The latitude in degrees. It must be in the range [-90.0, +90.0].

  Format: double

  Type: number

  requiredQuality

  Type: string

  Enum:

  • IMAGERY_QUALITY_UNSPECIFIED
  • HIGH
  • MEDIUM
  • LOW

  Location: query

  Enum Descriptions:

  • No quality is known.
  • The underlying imagery and DSM data were processed at 0.1 m/pixel.
  • The underlying imagery and DSM data were processed at 0.25 m/pixel.
  • The underlying imagery and DSM data were processed at 0.5 m/pixel.

  Description: Optional. The minimum quality level allowed in the results. No result with lower quality than this will be returned. Not specifying this is equivalent to restricting to HIGH quality only.

  location.longitude

  Location: query

  Description: The longitude in degrees. It must be in the range [-180.0, +180.0].

  Type: number

  Format: double

  Description: Gets solar information for a region surrounding a location. Returns an error with code `NOT_FOUND` if the location is outside the coverage area.

• ▼ ▲ solar.buildingInsights.findClosest

  Flat Path: v1/buildingInsights:findClosest

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Path: v1/buildingInsights:findClosest

  Description: Locates the closest building to a query point. Returns an error with code `NOT_FOUND` if there are no buildings within approximately 50m of the query point.

  Parameters:

  location.longitude

  Location: query

  Format: double

  Description: The longitude in degrees. It must be in the range [-180.0, +180.0].

  Type: number

  location.latitude

  Type: number

  Description: The latitude in degrees. It must be in the range [-90.0, +90.0].

  Location: query

  Format: double

  requiredQuality

  Location: query

  Type: string

  Description: Optional. The minimum quality level allowed in the results. No result with lower quality than this will be returned. Not specifying this is equivalent to restricting to HIGH quality only.

  Enum:

  • IMAGERY_QUALITY_UNSPECIFIED
  • HIGH
  • MEDIUM
  • LOW

  Enum Descriptions:

  • No quality is known.
  • The underlying imagery and DSM data were processed at 0.1 m/pixel.
  • The underlying imagery and DSM data were processed at 0.25 m/pixel.
  • The underlying imagery and DSM data were processed at 0.5 m/pixel.

  HTTP Method: GET