A list of changes to the Raptor Maps API.
2025-07-08
Made a large update to the Next Gen anomalies endpoints.
The first major change was made with performance in mind. Returning the image data for a single anomaly is a relatively minor matter but the extra data from the image links adds up when pulling hundreds or thousands of anomalies. The image data is still available, but in order to retrieve it, a query parameter must be added to the request URL.
New pattern for retrieving images
Old URL
https://api.raptormaps.com/v2/solar_inspections/{inspection_id}/anomalies?org_id={org_id}&limit=100&offset=0
New URL
https://api.raptormaps.com/v2/solar_inspections/{inspection_id}/anomalies?org_id={org_id}&limit=100&offset=0&images=True
For the GET defects route, if the images query parameter is not included it will default to false and the response object will not contain the image URLs.
However, for the GET defects by defects ID route, if the images parameter is not included, it will default to true and the response object will contain the image URLs.
The second major change is that we’ve removed some fields that have no external use. We hope this will cut down on confusion when determining what information to extract from the data object. We're also not returning fields that have null values.
Here are the details of the changes at the response object level
Current | Images=False | Images=True | Notes |
---|---|---|---|
id | id | id | |
custom_locator_text | custom_locator_text | custom_locator_text | |
farm_object | We've removed the farm object but pulled the important information into the payload | ||
object_id | object_id | Pulled from the farm_object to flatten anomaly response and avoid data duplication | |
solar_farm_id | solar_farm_id | Pulled from farm_object | |
objection_notation_text | object_notation_text | ||
object_type | |||
geom | geom | geom | |
Action | We have deprecated smart actions and removed the field from the response | ||
inspection_id | inspection_id | inspection_id | |
primary_shape_id | primary_shape_id | ||
linked_shape_id | linked_shape_id | ||
tag | tag | tag | |
uuid | UUID was not a field used in integrations so we removed it. | ||
priority | priority | priority | |
primary_image_filename | primary_image_filename | ||
primary_image_id | primary_image_id | ||
primary_image_url | primary_image_url | ||
primary_thumbnail_url | primary_thumbnail_url | ||
linked_imaged_filename | linked_image_filename | ||
linked_image_id | linked_image_id | ||
linked_image_url | linked_image_url | ||
linked_thumbnail_url | linked_thumbnail_url | ||
avg_temp | avg_temp | avg_temp | |
created_tsecs | created_tsecs | created_tsecs | |
delta_t | delta_t | delta_t | |
feedback | Removed because it wasn't used | ||
group_name | |||
inspection_uuid | This UUID wasn't being used either so it was also removed. | ||
irradiance | irradiance | irradiance | |
irradiance_tsecs | irradiance_tsecs | irradiance_tsecs | |
max_temp | max_temp | max_temp | |
min_temp | min_temp | min_temp | |
norm_delta_t | norm_delta_t | norm_delta_t | |
sensor_id | sensor_id | sensor_id | |
anomaly_life_cycle | anomaly_life_cycle | anomaly_life_cycle | |
anomaly_custom_locator_text | anomaly_custom_locator_text |
2025-05-19
Added a table of values to GET /anomalies for the purposes of sorting
2025-04-23
Updated postman collection to match recent additions to documentation
2025-04-17
Increased number of export API in Next Gen subsection to match what's available through the frontend.
2025-04-15
Removed beta designation from Next Gen APIs header
2025-04-11
Updated next gen solar farms route description to include changes that allow for sorting and filtering.
2025-01-28
Added CSV export route. Updated section headers.
2024-12-27
Added PDF route to docs
2024-12-20
Added units to windspeed and temperature.
2024-12-17
Updated glossary items for Priority and Life Cycle Status
2024-12-13
Updated glossary items for Actions and Tags
2024-12-02
Updated the glossary with more complete explanation for location notation.
2024-11-26
Added v2 findings route to nextgen APIs
2024-11-25
Added some fields to glossary with more explanation text and some links.
2024-11-05
Updated titles for image download API
2024-10-28
Expanded glossary to include inspection response fields.
2024-10-25
Updated glossary
2024-10-15
Updated the document structure in order to add a glossary and make the information that's generic to all endpoints and service more obvious.
2024-10-01
Added GET defect_images and GET farm by ID to Next Gen API section
2024-07-22
Added section for V2 API
2024-07-11
Updated token audience param value to offer broader permissions
2024-06-28
Added work order task endpoints to main documentation
2024-06-26
Added work order endpoints to main documentation
2024-06-20
Made some adjustments to ppa rate API
2024-06-07
Added collections to Postman Workspace
2024-06-04
Added asset_id to 200 response for /solar_farm routes that return a solar farm object.
2024-05-20
Added PPA rate APIs.
2024-05-10
Added anomaly location document endpoint. Removed fully deprecated legacy routes - /shp, /kml
2024-05-01
Removed legacy routes that have been fully deprecated from the code - /pdf, /k_nearest_images, and /jobs/<jobs_uuid>.
2023-12-20
Removed non-functional and unused APIs from the documentation. Added Summary route. Added ability to properly access legacy routes.
2023-11-14
A new endpoint for retrieving API tokens is now live! Updated instructions can be found at Using the Raptor Maps API.
Direct link to detailed endpoint docs - Get API Access Token
Existing API consumers not yet using this endpoint should migrate any existing code, integrations, etc. to use this new endpoint. Thank you!
2023-08-21
API Guidance around how often API tokens should be acquired is now updated, API consumers should take note and make a best effort at following the guidelines.
2023-08-15
We've updated our API Authentication to a more secure method! Be sure to check the updated instructions on the Getting Started page.
2023-04-04
The backend API endpoint URL for https://app.raptormaps.com was changed to https://app-legacy.raptormaps.com. The frontend application is still accessible at https://app.raptormaps.com. Most API usage should use the latest API at https://api.raptormaps.com except for data ingestion, which remains at https://app-legacy.raptormaps.com
2021-06-11
Update 2023-04-04: https://app.raptormaps.com was moved to https://app-legacy.raptormaps.com.
Endpoints in "Raptor App API" at https://app.raptormaps.com were migrated to "Raptor App API (NEW)" at https://api.raptormaps.com between June to July 2021. Not all endpoints will be migrated immediately.
Inspection results delivered prior to June 11, 2021 will still be available at https://app.raptormaps.com until August 31, 2021.
Inspections delivered after June 11, 2021 will only be available at https://api.raptormaps.com. Deprecated currently endpoints are marked as "deprecated" at the top of the description.
For example:
If inspection results were delivered to your organization on June 11, 2021. The findings table can be accessed at https://app.raptormaps.com/api/v2/solar_inspections/<inspection_uuid>/findings AND https://api.raptormaps.com/solar_inspections/<inspection_id>/findings.
If inspection results were delivered to your organization on June 14, 2021 the findings table can only be accessed at https://api.raptormaps.com/solar_inspections/<inspection_id>/findings.
Historical API request results contained both UUIDs and IDs and accessed via UUID. Going forward requests will use ID.