Data API (version 2.0)

Data API Use Cases

The Outdooractive Data API is used to load content from the Outdooractive Platform triggered by user interaction (e.g. filter requests and content details) or to synchronize the content of an API project to another system. Please see our docs about synchronisation to keep content up to date with minimal load for both systems:

Urls and Parameters

A request to the outdooractive Data API is only valid if an outdooractive API key and an outdooractive project key are used. The following test keys are used in all examples and the reference. You are welcome to use these keys for temporary testing purposes.

Project Key for testing

api-dev-oa

API Key for testing

yourtest-outdoora-ctiveapi

Data API Base Url

// project key: "api-dev-oa"
https://api-oa.com/api/v2/project/api-dev-oa/

Mandatory parameters

// format: json or xml
format=json

// API key
key=yourtest-outdoora-ctiveapi

Category

Every outdooractive API project has its own category tree which is a two level hierarchy of project categories which are organized in category groups.

API Endpoint

https://api-oa.com/api/v2/project/api-example-sync/category/tree?type=tour&lang=de&key=yourtest-outdoora-ctiveapi

Types

tour|poi|event|offer

The category tree of an outdooractive API project is pruned by default (empty categories are not listed). Request unpruned tree with all categories:

https://api-oa.com/api/v2/project/api-example-sync/category/tree?type=tour&lang=de&key=yourtest-outdoora-ctiveapi&pruned=false

Content

Request list of project content like tours and POIs:

https://api-oa.com/api/v2/project/api-dev-oa/contents?type=tour&key=yourtest-outdoora-ctiveapi

Get the full information of some content objects:

https://api-oa.com/api/v2/project/api-dev-oa/contents/1373438,1397449?display=verbose&lang=de&key=yourtest-outdoora-ctiveapi

The same request reduced to a minimal set of attributes:

https://api-oa.com/api/v2/project/api-dev-oa/contents/1373438,1397449?display=snippet&lang=de&key=yourtest-outdoora-ctiveapi

Look up content object ids and date of last modification:

https://api-oa.com/api/v2/project/api-dev-oa/contents?type=tour&typeFields=id,lastModifiedAt,importKey&count=10000&startIndex=0&format=json&key=yourtest-outdoora-ctiveapi

Images

Images are content objects with a title and description. The outdooractive platform uses content relations to link images of content objects like tours and POIs. The images related to a content object are referenced by an outdooractive id in all object representations.

The default Url to an image object’s image file:

https://img.oastatic.com/img2/6128163/default/variant.jpg

All images are available at several sizes (width/height):

https://img.oastatic.com/img2/6128163/80x80r/variant.jpg
https://img.oastatic.com/img2/6128163/420x237r/variant.jpg
https://img.oastatic.com/img2/6128163/1600x904r/variant.jpg

Download

GPX:

https://api-oa.com/download.tour.gpx?i=1550935&project=api-dev-oa&key=yourtest-outdoora-ctiveapi

KML:

https://api-oa.com/kml_generate?i=1550935&project=api-dev-oa&key=yourtest-outdoora-ctiveapi

Legacy Data API v1.0