Data API Documentation

Authenticate with your credentials:

{{authError}}

Test the API:

As a member of the MAPEGY Team, you can automatically see all SCOUT-related API routes. Everyone else needs to authenticate with their API credentials first!

Use the "API Tester" credentials to showcase the API.
Use the "Internal API" credentials to see all existing API routes.

{{reqLimits}}

{{reqError}}

https://api.mapegy.com/

POST

GET

Run Test Query

								Request: {{method.testRequest}}


								Response:{{method.testResponse | json}}

Required Parameters

{{opt_name}} = What is this? (multiple comma-separated values possible)

Optional Parameters

{{opt_name}} = What is this? (multiple comma-separated values possible)

Connect the API to your application. Get the demo app for your developers:

Download

(credentials included)

Additional remarks

How to use MAPEGY's standard query format ("q" parameter)

// example in JavaScript

function ScoutQuery() {
	this.format_version = '1.6.0';
	this.data = {
		/*
			SEMANTIC SEARCH
			If used, ADVANCED SEARCH is limited to "organizations" in the format [[x1,x2,...]].
		*/
		semantic: ''

		/*
			ADVANCED SEARCH
			Each field contains a nested array of search terms in the format [[x1,x2,...], [y1,y2,...], ...]
			which represents the Boolean query (x1 OR x2 OR ...) AND (y1 OR y2 OR ...) AND ...
		*/

		// Topic names
		topics: [],
		not_topics: [], // AND NOT (...)

		// Organization names
		organizations: [],
		not_organizations: [], // AND NOT (...)
	};
};

// initialize query
var query = new ScoutQuery();

// add terms to query
query.data.topics.push(['artificial intelligence', 'deep learning']);

// build url
var queryParam = '?q=' + encodeURIComponent(JSON.stringify(query));
var route = 'Documents';
var url = 'https://api.mapegy.com/' + route + '/' + queryParam;