Documentation

To start using the API please register and create an API token for your project. The documentation for all offered services is available below:

Extracts and returns semantic metadata like concepts from the reegle thesaurus, locations and terms from a text.

URL: http://api.climatetagger.net/service/extract

Request

Supported Methods
GET
POST

HTTP Parameters

Parameter Comment Type
textrequired Raw text to extract from. The text has to be in UTF-8 encoding. String
localerequired Locale of the text as ISO 639-2 language code (e.g. "en" for English). String
formatrequired Return format of the results. Possible values:
  • rdfxml
  • json
  • jsonld
String
tokenrequired A valid authentication token which has been generated in the climatetagger API dashboard. String
taggeroptional This feature allows to specify a specific section of the thesaurus for even more precise tagging for relevant topics. The default setting is "select all", using the entire Climate Tagger thesaurus. Available thesaurus topics to select:
  • Select all (Climate Tagger)
  • Climate Change Adaptation
  • Energy Efficiency
  • Renewable Energy (Renewables Tagger)
  • Climate Change Mitigation
String
locationsoptional Set to true if locations should be extracted and returned. Default: false Boolean
countConceptsoptional The number of Concepts to be retrieved. If not specified (set to 0), no concepts from the thesaurus will be returned. Integer
countTermsoptional The number of Terms to be retrieved. If not specified (set to 0), no terms will be returned. Integer
conceptInfooptional A comma-separated list of additional attributes / facts to be returned along with the extracted Concepts.
The response will look different depending on the attributes defined in the request.
Possible values:
  • altLabel
  • hiddenLabel
  • related
  • topConcept
  • broaderTransitive
  • inScheme
List of Strings

Response

JSON

The response is a JSON object with the following attributes:

  • concepts - A list of extracted Concept objects
  • terms - A list of extracted Term objects
  • locations - A list of extracted Location objects
Concepts
Attribute Comment Concept Info
score The score denotes how important the retrieved term or Concept is in the input document.
The range is between 0-100, where 100 stands for the most important, and 0 stands for the least important term/Concept.
uri The Concept URI.
prefLabel The preferred label of the extracted Concept.
altLabel The alternative labels of the extracted Concept. altLabel
hiddenLabel The hidden labels of the extracted Concept. hiddenLabel
inScheme The ConceptSchemes that the extracted Concept resides in. (only for type Concept). A ConceptScheme can be viewed as an aggregation of one or more Concepts. E.g. “Persons” can be a ConceptScheme under which the actual person Concepts reside, one Concept can occur in more than one ConceptSchemes. The inScheme property holds all the ConceptSchemes a Concept resides in. inScheme
broaderTransitive All transitive broader Concepts of the extracted Concept. Transitive means: not only the direct broader Concepts of a Concept but also their broader Concepts and so on. This list represents the path through the hierarchy starting from the extracted Concept to the first level of the thesaurus. broaderTransitive
related All related Concepts of the extracted Concept. related
topConcept The top-level Concept in the thesaurus that the extracted Concept is associated to, i.e. the extracted Concept is in the sub-tree of the TopConcept. topConcept

Terms
Attribute Comment
score The score denotes how important the retrieved term or Concept is in the input document. The range is between 0-100, where 100 stands for the most important, and 0 stands for the least important term/Concept.
label The label extracted from the input is returned.

Locations
Attribute Comment
type
  • City
  • Country
name The common name of the location.
uri Corresponding Geonames URI or the location.
latitude Latitude
longitude Longitude
ppx:reegleCountry URI of the associated reegle country resource.

Concept Scheme
Attribute Comment
uri ConceptScheme URI.
label Localized label of the ConceptScheme.

Example Response
{
"concepts": [
  { "score": 100,
    "uri": "http://reegle.info/glossary/1351",
    "prefLabel": "European Investment Bank",
    "inScheme": [
      { "label": "Climate Compatible Development  Thesaurus",
        "uri": "http://reegle.info/glossary/1"
      }
    ],
    "altLabel": ["EIB"]
  },
  { "score": 49,
    "uri": "http://reegle.info/glossary/1346",
    "prefLabel": "Asian Development Bank",
    "inScheme": [
      { "label": "Climate Compatible Development  Thesaurus",
        "uri": "http://reegle.info/glossary/1"
      }
    ],
    "altLabel": ["ADB"]
  },
  { "score": 19,
    "uri": "http://reegle.info/glossary/1715",
    "prefLabel": "distribution automation",
    "inScheme": [
      { "label": "Energy Efficiency Thesaurus",
        "uri": "http://reegle.info/glossary/1700"
      }
    ],
    "altLabel": ["DA"]
  }
],
"terms": [
  { "label": "million",
    "score": 73
  },
  { "label": "projects",
    "score": 28
  },
  { "label": "EIB will provide",
    "score": 25
  }
],
"locations": [
   { "name": "Lagos",
     "type": "City",
     "uri": "http://sws.geonames.org/2332459/",
     "latitude": 6.45306,
     "longitude": 3.39583,
     "reegleCountry": "http://reegle.info/countries/NG"
   }
 ]
}
                    

RDF/XML and JSON-LD

Concepts
RDF Property Comment Concept Info
rdf:type skos:Concept - the extracted entity is a Concept from the thesaurus.
ppx:score The score denotes how important the retrieved term or Concept is in the input document.
The range is between 0-100, where 100 stands for the most important, and 0 stands for the least important term/Concept.
skos:prefLabel If the type is Concept, the preferred label of the concept is returned.
skos:altLabel The alternative labels of the extracted Concept. altLabel
skos:hiddenLabel The hidden labels of the extracted Concept. hiddenLabel
skos:inScheme The URIs of the ConceptSchemes that the extracted Concept resides in. (only for type Concept). A ConceptScheme can be viewed as an aggregation of one or more Concepts. E.g. “Persons” can be a ConceptScheme under which the actual person Concepts reside, one Concept can occur in more than one ConceptSchemes. The inScheme property holds all the ConceptSchemes a Concept resides in. inScheme
skos:broaderTransitive All transitive broader Concepts of the extracted Concept. Transitive means: not only the direct broader Concepts of a Concept but also their broader Concepts and so on. This list represents the path through the hierarchy starting from the extracted Concept to the first level of the thesaurus. broaderTransitive
skos:related All related Concepts of the extracted Concept. related
ppx:topConcept The top-level Concept in the thesaurus that the extracted Concept is associated to, i.e. the extracted Concept is in the sub-tree of the TopConcept. topConcept

Terms
RDF Property Comment
rdf:type ppx:Term - the extracted entity is a term with no relation to a thesaurus concept.
ppx:score The score denotes how important the retrieved term or Concept is in the input document. The range is between 0-100, where 100 stands for the most important, and 0 stands for the least important term/Concept.
rdfs:label The label extracted from the input is returned.

Locations

RDF Property Comment
rdf:type
  • http://schema.org/City - the extracted entity is a City.
  • http://schema.org/Country - the extracted entity is a Country.
geonames:name The common name of the location.
geo:lat Latitude
geo:long Longitude
ppx:reegleCountry URI of the associated reegle country resource.

Extracts and returns semantic metadata like concepts from the Climate Tagger thesaurus, locations and terms from a file (Microsoft Word, Powerpoint, PDF and plain text files are supported).

URL: http://api.climatetagger.net/service/extractFile

Request

Supported Methods
POST

HTTP Parameters

Parameter Comment Type
filerequired The binary file content sent as multipart/form-data.
Currently only Microsoft Word, Powerpoint, PDF and plain text files are supported.
File
localerequired Locale of the text as ISO 639-2 language code (e.g. "en" for English). String
formatrequired Return format of the results. Possible values:
  • rdfxml
  • json
  • jsonld
String
tokenrequired A valid authentication token which has been generated in the climatetagger API dashboard. String
taggeroptional This feature allows to specify a specific section of the thesaurus for even more precise tagging for relevant topics. The default setting is "select all", using the entire Climate Tagger thesaurus. Available thesaurus topics to select:
  • Select all (Climate Tagger)
  • Climate Change Adaptation
  • Energy Efficiency
  • Renewable Energy (Renewables Tagger)
  • Climate Change Mitigation
String
locationsoptional Set to true if locations should be extracted and returned. Default: false Boolean
countConceptsoptional The number of Concepts to be retrieved. If not specified (set to 0), no concepts from the thesaurus will be returned. Integer
countTermsoptional The number of Terms to be retrieved. If not specified (set to 0), no terms will be returned. Integer
conceptInfooptional A comma-separated list of additional attributes / facts to be returned along with the extracted Concepts.
The response will look different depending on the attributes defined in the request.
Possible values:
  • altLabel
  • related
  • topConcept
  • broaderTransitive
  • inScheme
List of Strings

Response

JSON

The response is a JSON object with the following attributes:

  • concepts - A list of extracted Concept objects
  • terms - A list of extracted Term objects
  • locations - A list of extracted Location objects
Concepts
Attribute Comment Concept Info
score The score denotes how important the retrieved term or Concept is in the input document.
The range is between 0-100, where 100 stands for the most important, and 0 stands for the least important term/Concept.
uri The Concept URI.
prefLabel The preferred label of the extracted Concept.
altLabel The alternative labels of the extracted Concept. altLabel
hiddenLabel The hidden labels of the extracted Concept. hiddenLabel
inScheme The ConceptSchemes that the extracted Concept resides in. (only for type Concept). A ConceptScheme can be viewed as an aggregation of one or more Concepts. E.g. “Persons” can be a ConceptScheme under which the actual person Concepts reside, one Concept can occur in more than one ConceptSchemes. The inScheme property holds all the ConceptSchemes a Concept resides in. inScheme
broaderTransitive All transitive broader Concepts of the extracted Concept. Transitive means: not only the direct broader Concepts of a Concept but also their broader Concepts and so on. This list represents the path through the hierarchy starting from the extracted Concept to the first level of the thesaurus. broaderTransitive
related All related Concepts of the extracted Concept. related
topConcept The top-level Concept in the thesaurus that the extracted Concept is associated to, i.e. the extracted Concept is in the sub-tree of the TopConcept. topConcept

Terms
Attribute Comment
score The score denotes how important the retrieved term or Concept is in the input document. The range is between 0-100, where 100 stands for the most important, and 0 stands for the least important term/Concept.
label The label extracted from the input is returned.

Locations
Attribute Comment
type
  • City
  • Country
name The common name of the location.
uri Corresponding Geonames URI or the location.
latitude Latitude
longitude Longitude
ppx:reegleCountry URI of the associated reegle country resource.

Concept Scheme
Attribute Comment
uri ConceptScheme URI.
label Localized label of the ConceptScheme.

Example Response
{
"concepts": [
  { "score": 100,
    "uri": "http://reegle.info/glossary/1351",
    "prefLabel": "European Investment Bank",
    "inScheme": [
      { "label": "Climate Compatible Development  Thesaurus",
        "uri": "http://reegle.info/glossary/1"
      }
    ],
    "altLabel": ["EIB"]
  },
  { "score": 49,
    "uri": "http://reegle.info/glossary/1346",
    "prefLabel": "Asian Development Bank",
    "inScheme": [
      { "label": "Climate Compatible Development  Thesaurus",
        "uri": "http://reegle.info/glossary/1"
      }
    ],
    "altLabel": ["ADB"]
  },
  { "score": 19,
    "uri": "http://reegle.info/glossary/1715",
    "prefLabel": "distribution automation",
    "inScheme": [
      { "label": "Energy Efficiency Thesaurus",
        "uri": "http://reegle.info/glossary/1700"
      }
    ],
    "altLabel": ["DA"]
  }
],
"terms": [
  { "label": "million",
    "score": 73
  },
  { "label": "projects",
    "score": 28
  },
  { "label": "EIB will provide",
    "score": 25
  }
],
"locations": [
   { "name": "Lagos",
     "type": "City",
     "uri": "http://sws.geonames.org/2332459/",
     "latitude": 6.45306,
     "longitude": 3.39583,
     "reegleCountry": "http://reegle.info/countries/NG"
   }
 ]
}
                    

RDF/XML and JSON-LD

Concepts
RDF Property Comment Concept Info
rdf:type skos:Concept - the extracted entity is a Concept from the thesaurus.
ppx:score The score denotes how important the retrieved term or Concept is in the input document.
The range is between 0-100, where 100 stands for the most important, and 0 stands for the least important term/Concept.
skos:prefLabel If the type is Concept, the preferred label of the concept is returned.
skos:altLabel The alternative labels of the extracted Concept. altLabel
skos:hiddenLabel The hidden labels of the extracted Concept. hiddenLabel
skos:inScheme The URIs of the ConceptSchemes that the extracted Concept resides in. (only for type Concept). A ConceptScheme can be viewed as an aggregation of one or more Concepts. E.g. “Persons” can be a ConceptScheme under which the actual person Concepts reside, one Concept can occur in more than one ConceptSchemes. The inScheme property holds all the ConceptSchemes a Concept resides in. inScheme
skos:broaderTransitive All transitive broader Concepts of the extracted Concept. Transitive means: not only the direct broader Concepts of a Concept but also their broader Concepts and so on. This list represents the path through the hierarchy starting from the extracted Concept to the first level of the thesaurus. broaderTransitive
skos:related All related Concepts of the extracted Concept. related
ppx:topConcept The top-level Concept in the thesaurus that the extracted Concept is associated to, i.e. the extracted Concept is in the sub-tree of the TopConcept. topConcept

Terms
RDF Property Comment
rdf:type ppx:Term - the extracted entity is a term with no relation to a thesaurus concept.
ppx:score The score denotes how important the retrieved term or Concept is in the input document. The range is between 0-100, where 100 stands for the most important, and 0 stands for the least important term/Concept.
rdfs:label The label extracted from the input is returned.

Locations

RDF Property Comment
rdf:type
  • http://schema.org/City - the extracted entity is a City.
  • http://schema.org/Country - the extracted entity is a Country.
geonames:name The common name of the location.
geo:lat Latitude
geo:long Longitude
ppx:reegleCountry URI of the associated reegle country resource.

This service allows you to send a document to the content pool to be added to the semantic index. Documents in the content pool can be recommended to other API users.

URL: http://api.climatetagger.net/service/push

Request

Supported Methods
GET
POST

HTTP Parameters

* = mandatory parameter

Parameter Comment Type
titlerequired Title of the document to extract from. Has to be in UTF-8 encoding. String
textrequired Raw text to extract from. The text has to be in UTF-8 encoding. String
localerequired Locale of the text as ISO 639-2 language code (e.g. "en" for English). String
documentUrlrequired URL to access the document on the web. String
tokenrequired A valid authentication token which has been generated in the climatetagger API dashboard. String
taggeroptional This feature allows to specify a specific section of the thesaurus for even more precise tagging for relevant topics. The default setting is "select all", using the entire Climate Tagger thesaurus. Available thesaurus topics to select:
  • Select all (Climate Tagger)
  • Climate Change Adaptation
  • Energy Efficiency
  • Renewable Energy (Renewables Tagger)
  • Climate Change Mitigation
String
dateoptional Creation date (and time) of the document in ISO 8601 format.
Include your local timezone offset at the end (e.g. +0100 for GMT +1), otherwise it will be assumed to be in the GMT timezone.
Examples:
2012-07-14T12:44:00+0200
2011-02-26T17:01:54-0900

If no date is given the time of indexing will be used instead.
String
internaloptional Default: false
If the flag is set to true, the document will only be accessible to the account that submitted it.
Boolean

Response

The response will contain the unique ID of the document within the Content Pool as plain text.

Important!

This unique ID is required to call the Similar Documents Service!

This service allows the user to send a document to the Climate Tagger API service. On the basis of this submitted document it is possible to receive similar documents (as return value from the API) that are available from the continuously growing Climate Tagger API content pool. The content pool consists of documents submitted by 3rd parties (other API users, REEEP). You are able to use these documents to build your own innovative / enriched services – for example to provide 'similar content widgets' on your blog or website – or in your internal information system using this content & data. (go to Request Builder)

Similarity is determined by comparing the semantic tags attached to the documents.

URL: http://api.climatetagger.net/service/similar

Request

Supported Methods
GET
POST

HTTP Parameters

* = mandatory parameter

Parameter Comment Type
documentIdrequired Unique document identifier that was retrieved when the document was submitted using the Content Pool Push Service. String
tokenrequired A valid authentication token which has been generated in the climatetagger API dashboard. String
countDocumentsoptional The number of documents to be returned (default: 10, maximum: 50). Integer
filterLocalesoptional A comma-separated list of ISO 639-2 language codes to restrict the recommended documents (e.g. en,fr,es). List of String
filterSourcesoptional A comma-separated list of source IDs that the similar documents should originate from. List of Integer

Response

The response is a JSON object with the following attributes:

  • documents - A list of recommended document objects

Document

Attribute Comment
score The score denotes the similarity of the recommended document compared to the input document.
id The unique document identifier.
source Name of the source that this document originates from.
sourceId ID of the source that this document originates from.
link Document URL.
title Document title.
preview A short textual preview snippet of the document content.

Example Response

{

    "documents": [
        {
            "id": "3c0f6a5d2697bf3d911bef7206b08e37",
            "source": "reegle Project Outputs",
            "sourceId": 5,
            "link": "http://reeep.org/file_upload/10401027_2.pdf",
            "title": "TREC's Survey for \"RECCs - Renewable Energy Cooperation for development Certificates\" Project",
            "score": 5.1195736,
            "preview": " RECCs Renewable Energy Cooperation for development Certificates Project TRECs SURVEY ISES ITALY Italian Section ..."
        },
        {
            "id": "683f384fe8b0fc07e811583f7c1651c1",
            "source": "reegle Project Outputs",
            "sourceId": 5,
            "link": "http://reeep.org/file_upload/10301078_1.pdf",
            "title": "Policy & Regulatory Approaches for Promoting\n RE Power",
            "score": 4.412426,
            "preview": " Policy Regulatory Approaches for Promoting RE Power Prepared under the REEEP project Capacity building for state regulators ..."
        },
        {
            "id": "fd58414d193b5f28f7da55bd6f691f4f",
            "source": "reegle Project Outputs",
            "sourceId": 5,
            "link": "http://reeep.org/file_upload/10605005_4.pdf",
            "title": "Green and White Certificates Market Construction and Implementation: The Italian Experience",
            "score": 3.701044,
            "preview": " Green and White certificates market construction and implementation The Italian experience Emanuele Piccinno CIRPS University ..."
        }
    ]
}
            

This service allows the user to receive and use documents from a specified area of interest from the continuously growing Climate Tagger API content pool to suit exact needs. To specify needs and requirements you must register for the API and then specify the document attributes which you are interested in by selection from a filter system. This filter system is part of the request builder and consists of A) topics B) sources available in the Climate Tagger API content pool, and C) countries. Using this automatically created API request enables you to fetch the relevant documents from the API to build new and innovative / enriched services for your own information system using this content & data. (go to Request Builder)

URL: http://api.climatetagger.net/service/recommend

Request

Supported Methods
GET
POST

HTTP Parameters

* = mandatory parameter

Parameter Comment Type
tokenrequired A valid authentication token which has been generated in the climatetagger API dashboard. String
countDocumentsoptional The number of documents to be returned (default: 10, maximum: 50). Integer
filterLocalesoptional A comma-separated list of ISO 639-2 language codes to restrict the recommended documents (e.g. en,fr,es). List of String
filterSourcesoptional A comma-separated list of source IDs that the recommended documents should originate from. List of Integer
filterCountriesoptional A comma-separated list of either ISO 3166-1 alpha-2 country codes (uppercase!) or reegle country URIs - only documents with a relation to these countries will be recommended. List of String
filterTopicsoptional A comma-separated list of Top Concept URIs from the reegle thesaurus - only documents categorized in these Topics will be recommended. List of String

Response

The response is a JSON object with the following attributes:

  • documents - A list of recommended document objects

Document

Attribute Comment
score The score denotes the relevancy of the recommended document.
id The unique document identifier.
source Name of the source that this document originates from.
sourceId ID of the source that this document originates from.
link Document URL.
title Document title.
preview A short textual preview snippet of the document content.

Example Response

{

    "documents": [
        {
            "id": "3c0f6a5d2697bf3d911bef7206b08e37",
            "source": "reegle Project Outputs",
            "sourceId": 5,
            "link": "http://reeep.org/file_upload/10401027_2.pdf",
            "title": "TREC's Survey for \"RECCs - Renewable Energy Cooperation for development Certificates\" Project",
            "score": 5.1195736,
            "preview": " RECCs Renewable Energy Cooperation for development Certificates Project TRECs SURVEY ISES ITALY Italian Section ..."
        },
        {
            "id": "683f384fe8b0fc07e811583f7c1651c1",
            "source": "reegle Project Outputs",
            "sourceId": 5,
            "link": "http://reeep.org/file_upload/10301078_1.pdf",
            "title": "Policy & Regulatory Approaches for Promoting\n RE Power",
            "score": 4.412426,
            "preview": " Policy Regulatory Approaches for Promoting RE Power Prepared under the REEEP project Capacity building for state regulators ..."
        },
        {
            "id": "fd58414d193b5f28f7da55bd6f691f4f",
            "source": "reegle Project Outputs",
            "sourceId": 5,
            "link": "http://reeep.org/file_upload/10605005_4.pdf",
            "title": "Green and White Certificates Market Construction and Implementation: The Italian Experience",
            "score": 3.701044,
            "preview": " Green and White certificates market construction and implementation The Italian experience Emanuele Piccinno CIRPS University ..."
        }
    ]
}