Cyclorama Rendering API

Our Cyclorama Rendering API is a REST service that you can use to create cut-outs of cycloramas. Based on an address or coordinates you can render JPG files that can be used for a variety of documents and publications, including websites. In addition, the JPG cut-outs can also be used for texturing 3D models. The Cyclorama Rendering API is our most simple API to integrate Cyclomedia’s street-level imagery into your work.

Obtain API credentials

Before you can start using this API, you need to have an API Key and login credentials. If you do not have them yet, please use this form to request access.

Request your API credentials

Read the documentation

Everything you need to know about the Cyclorama Rendering API (formerly known as Panorama Rendering Service) can be found in this API Reference Document.

Download the API documentation

View our examples

To help you getting started, we have created a set of code examples for you. You can use them as a basis for your own REST requests.

Explore the code examples

API documentation

Overview of parameters

Operations and response

The Cyclorama Rendering API is a REST service that uses basic authentication. The following operations are possible:

Render

Renders an image based on the ID of a recording.

RenderByLocation2D

Renders an image based on the recording nearest to a given 2D location.

RenderByLocation3D

Renders an image based on the recording nearest to a given 3D location.

RenderByAddress

Renders an image based on the recording nearest to a specified address.

RenderSurface

Returns an image of a flat surface as defined by a set of four coordinates. This is typically used for creating surfaces on 3D models.

ListByAddress

Lists the recordings nearest to a given address location, includes historical recordings.

ListByLocation2D

Lists the recordings nearest to a given 2D location, includes historical recordings.

ListByCoordinates

Lists the recordings nearest to a given list of coordinates, includes historical recordings.

Response format

The response of all methods is a JPG image for the runtime rendered image, if not specified otherwise. Metadata is returned in HTTP response headers, for example:

Recording-Id: 5D0G4E8O
Recording-Date: 2011-09-15T12:48:07.5900000+02:00
Render-Width: 1024
Render-Height: 786
Render-FocalLength: 512.000
Render-HFov: 90.000
Render-VFov: 75.018
Render-Yaw: 0.000
Render-Pitch: 0.000
Render-Roll: 0.000
RecordingLocation-SrsBase: EPSG:4258
RecordingLocation-Longitude: 5.089819277
RecordingLocation-LongitudePrecision: 0.008
RecordingLocation-Latitude: 52.109259974
RecordingLocation-LatitudePrecision: 0.004
RecordingLocation-Height: 46.918
RecordingLocation-HeightPrecision: 0.009
RecordingLocation-GroundLevelOffset: 2.01
RecordingLocation-YawPrecision: 0.0075

Code examples

Render by recording ID

Render an image based on the ID of a recording.

Example request based on a recording ID:

https://atlasapi.cyclomedia.com/api/PanoramaRendering/Render/WE4AUJX6/?apiKey=
YourKeyGoesHere&width=1024&height=768&srsName=EPSG:28992&yaw=180

Render by coordinates

In these two examples, you will render an image of the Cyclorama that is closest to the specified coordinates.

Example request with a location in 2D coordinates:

https://atlasapi.cyclomedia.com/api/PanoramaRendering/RenderByLocation2D/28992/
94313.15/435711.11/?width=1024&height=786&apiKey=YourKeyGoesHere&index=0

Example request with a 3D location:

https://atlasapi.cyclomedia.com/api/PanoramaRendering/RenderByLocation3D/28992/
170126.70/440818.50/21.80/?width=1024&height=786&apiKey=YourKeyGoesHere&index=0

Render by address

These examples show how to render an image based on an address in the Netherlands and Belgium.

Example requests based on address:

https://atlasapi.cyclomedia.com/api/PanoramaRendering/RenderByAddress/NL/Tramstraat%2037,%20Eindhoven%205611CN/?apiKey=YourKeyGoesHere

https://atlasapi.cyclomedia.com/api/PanoramaRendering/RenderByAddress/BE/Snoekstraat%2012,%20Gent/?width=1024&height=786&apiKey=YourKeyGoesHere

Render a surface (texture)

This example returns an image of a flat surface as defined by a set of four coordinates. This is typically useful for creating surfaces (textures) on 3D models.

Example request for a traffic sign on a Dutch highway:

https://atlasapi.cyclomedia.com/api/PanoramaRendering/RenderSurface/28992/163939.296444;379550.768569;32.5940330406;163939.271713;379555.715094;32.5827216870;163939.232470;379555.677124;28.1069348311;163939.257536;379550.711447;28.1455324211/?apiKey=YourKeyGoesHere&maxelevation=65

Example request for the side of a building:

https://atlasapi.cyclomedia.com/api/PanoramaRendering/RenderSurface/28992/146221.595064;422841.765794;19.8390183574;146228.364368;422885.049088;20.0455430786;146228.391984;422885.111286;2.85253280443;146221.613937;422841.773320;2.83150864639/?apiKey=YourKeyGoesHere&index=1&margin=1.5

Retrieve a list of recordings

In these examples, you can retrieve a list of recordings that are nearest to an address, 2D location (coordinates) or surface (series of coordinates).

Example requests for addresses in the Netherlands and Belgium:

https://atlasapi.cyclomedia.com/api/PanoramaRendering/ListByaddress/NL/Eindhoven%20M arkt%202/?apiKey=YourKeyGoesHere

The output for this request is:

<?xml version="1.0" encoding="utf-8"?>
<imagedirection_list>
    <imagedirection recording-id="WE7KBPEM" 
      recording-date="2023-07-24T07:07:56.79Z" 
      viewing-direction="75.89607105873029" />
    <imagedirection recording-id="WE7KBPEL" 
      recording-date="2023-07-24T07:07:55.14Z" 
      viewing-direction="92.9422700037514" />
    <imagedirection recording-id="WE7KBPEN" 
      recording-date="2023-07-24T07:07:58.5Z" 
      viewing-direction="55.487747990601235" />
    <imagedirection recording-id="WE7KBPEK" 
      recording-date="2023-07-24T07:07:53.63Z" 
      viewing-direction="105.17740525563069" />
    <imagedirection recording-id="WE7KBPEO" 
      recording-date="2023-07-24T07:08:00.27Z" 
      viewing-direction="36.280820732106875" />
    <imagedirection recording-id="WE7KBPEJ" 
      recording-date="2023-07-24T07:07:52.19Z" 
      viewing-direction="113.39879050162166" />
    <imagedirection recording-id="WE7KBPEP" 
      recording-date="2023-07-24T07:08:01.96Z" 
      viewing-direction="21.535470733438878" />
    <imagedirection recording-id="WE7KBPEI" 
      recording-date="2023-07-24T07:07:50.74Z" 
      viewing-direction="118.99022684629837" />
    <imagedirection recording-id="WE7KBPEQ" 
      recording-date="2023-07-24T07:08:03.61Z" 
      viewing-direction="11.212487083590055" />
    <imagedirection recording-id="WE7KBPEH" 
      recording-date="2023-07-24T07:07:49.29Z" 
      viewing-direction="122.8706154540448" />
    <imagedirection recording-id="WE7KBPER" 
      recording-date="2023-07-24T07:08:05.24Z" 
      viewing-direction="4.052533023508913" />
</imagedirection_list>

https://atlasapi.cyclomedia.com/api/PanoramaRendering/ListByAddress/BE/Snoekstraat%2012,%20Gent/?apiKey=YourKeyGoesHere

<?xml version="1.0" encoding="utf-8"?>
<imagedirection_list>
    <imagedirection recording-id="WE3OJAX0" 
      recording-date="2021-10-13T13:43:47.97Z" 
      viewing-direction="-115.36083088867326" />
    <imagedirection recording-id="WE3OJAWZ" 
      recording-date="2021-10-13T13:43:47.24Z"
      viewing-direction="-145.15057142426846" />
    ......
    <imagedirection recording-id="WE3OJAX5" 
      recording-date="2021-10-13T13:43:51.17Z" 
      viewing-direction="-73.52135850850985" />
</imagedirection_list>

Example request for a list of recordings based on 2D coordinates:

https://atlasapi.cyclomedia.com/api/PanoramaRendering/ListByLocation2D/28992/161430.23 /383122.57?ApiKey=YourKeyGoesHere

<?xml version="1.0" encoding="utf-8"?>
<imagedirection_list>
    <imagedirection recording-id="WE7KBPN3" 
      recording-date="2023-07-24T07:19:09.29Z" 
      viewing-direction="62.648596474726986" />
    .....
    <imagedirection recording-id="WE7KBPMJ" 
      recording-date="2023-07-24T07:18:24.27Z" 
      viewing-direction="166.38892940209462" />
</imagedirection_list>

Example request for a list of recordings based on a series of coordinates:

https://atlasapi.cyclomedia.com/api/PanoramaRendering/ListByCoordinates/28992/163939.296444;379550.768569;32.5940330406;163939.271713;379555.715094;32.5827216870;163939.232470;379555.677124;28.1069348311;163939.257536;379550.711447;28.1455324211?ApiKey=YourKeyGoesHere

<?xml version="1.0"?>
<imagedirection_list>
    <imagedirection recording-id="WE6PZUIR" 
      recording-date="2023-04-07T09:38:42.35Z" 
      viewing-direction="-38.74933734623431" />
    .....
    <imagedirection recording-id="WE6Q20UZ" 
      recording-date="2023-04-06T06:31:26.6Z" 
      viewing-direction="-43.961897860207" />
</imagedirection_list>