Txoribista API (bird's-eye view or oblique images)
Resource Information
- URL
- https://b5m.gipuzkoa.eus/api/2.0/oblique
- Response Formats
- JSON
- Authentication
- No
- Limited ratio
- No
Through this API, you can view and query historical oblique images of Gipuzkoa (from the years 2007 and 2009). These oblique images are commonly referred to as "Txoribista" because they offer a perspective similar to that of a bird in flight. The B5m 2.0 viewer uses this API to provide and navigate through Txoribista images. You can use the API in three ways:
1. Query oblique images of a location
Using the coordinates of a location, you can check whether oblique images are available. To do so, follow these steps:
- 1.1. Check the presence of oblique images at a point. For example: 556702, 4771154, ETRS89 / UTM30N (EPSG:25830).
-
https://b5m.gipuzkoa.net/api/2.0/oblique?x=556702&y=4771154&srid=25830&type=features
- 1.2. Query the 2009 oblique images from the previous point.
-
https://b5m.gipuzkoa.net/api/2.0/oblique?year=2009&x=556702&y=4771154&srid=25830&type=features
Request parameters
| Parameter | Description | Default | Required |
|---|---|---|---|
| year | Year of the oblique image (2009 or 2007). | - | Yes |
| x | X coordinate of the point to query. | - | Yes |
| y | Y coordinate of the point to query. | - | Yes |
| srid | Spatial reference system (SRS), expressed in EPSG code. If not specified, the system will infer it automatically. Supported SRS include: EPSG:4326, EPSG:25830, and EPSG:3857. | - | Yes |
| type | Query type, in this case, it must be features. | - | Yes |
Response
1.1. If we have not set the year
The available years of oblique imagery will be displayed within the array ['data']['year']. If there are no oblique images, this value will be null.
1.2. If we have set the year
Data is found within the ['data']['features'] array, under the ['properties'] tag with the following fields:
| Field | Description |
|---|---|
| imagename | Name of the oblique image file. Required if you wish to make further queries on this image. |
| imagecols | Image width in pixels. |
| imagerows | Image height in pixels. |
| shotdate | Date the oblique image was taken. |
| shotorient | Orientation of the oblique image. |
2. Query coordinates within an oblique image
Once an oblique image is selected, you can query the location of a point within the image (in pixels).
- Query the location of a point within the previously mentioned oblique image.
-
https://b5m.gipuzkoa.net/api/2.0/oblique?x=556702&y=4771154&name=ESGU4006007NeighObliq4421N_091018&year=2009&type=measure
Request parameters
| Parameter | Description | Default | Required |
|---|---|---|---|
| x | X coordinate of the point to query in EPSG:25830 spatial reference system. | - | Yes |
| y | Y coordinate of the point to query in EPSG:25830 spatial reference system. | - | Yes |
| name | Name of the oblique image, obtained in the previous request under the imagename field. | - | Yes |
| year | Year of the oblique image (2009 or 2007). | - | Yes |
| type | Query type, in this case, it must be measure. | - | Yes |
Response
| Field | Description |
|---|---|
| x | X coordinate of the point within the image, in pixels. |
| y | Y coordinate of the point within the image, in pixels. |
(Note that the origin of the coordinates in the oblique image is at the top-left corner, i.e., the 0,0 point.)
3. Query geographic coordinates from an oblique image
From pixel coordinates within an oblique image, you can obtain the geographic coordinates of that point.
- Obtain geographic coordinates from pixel coordinates within an oblique image. The result will be in the EPSG:25830 spatial reference system.
-
https://b5m.gipuzkoa.net/api/2.0/oblique?px=1524&py=295&name=ESGU4006007NeighObliq4421N_091018&year=2009&type=measure
Request parameters
| Parameter | Description | Default | Required |
|---|---|---|---|
| px | X coordinate in the image, in pixels. | - | Yes |
| py | Y coordinate in the image, in pixels. | - | Yes |
| name | Name of the oblique image, obtained in the previous request under the imagename field. | - | Yes |
| year | Year of the oblique image (2009 or 2007). | - | Yes |
| type | Query type, in this case, it must be measure. | - | Yes |
Response
| Field | Description |
|---|---|
| X | X geographic coordinate of the oblique image in the EPSG:25830 system. |
| Y | Y geographic coordinate of the oblique image in the EPSG:25830 system. |
| Z | Z geographic coordinate of the oblique image, i.e., the orthometric height. |