API

Overview

ResourceContracts APIs are based on HTTP methods, which make it easy to write applications. These are GET APIs that retrieve only published contracts' information.

API Endpoint: https://api.resourcecontracts.org/

Home
/

Get All Contracts
/contracts

Search All Contracts
/contracts/search

Get Contract Metadata
/contract/{id}/metadata

Get Contract Annotations
/contract/{id}/annotations?page={page_no}

Get Contract Text
/contract/{id}/text?page={page_no}

Search Contract Pdf Text
/contract/{id}/searchtext

Get Summary
/contracts/summary

Get Annotation Group
/contract/{id}/annotations/group

Search Annotations
/contract/{id}/annotations/search

Get All Contract Count
/contracts/count

Grouped Full Text Search
/contracts/group

Grouped Full Text Search with Query Params
/contracts/group?q={query}&annotated={annotated}&recent={recent}&country_code={country_code}&year={year}&from={from}&per_page={per_page}&resource={resource}&corporate_group={corporate_group}&company_name={company_name}&contract_type={contract_type}&document_type={document_type}&language={language}&annotation_category={annotation_category}&sortby={sortby}&order={order}&group={group}&all={all}&download={download}&and={and}

Example: https://api.resourcecontracts.org/contracts/group?group=metadata|text|annotations&q=&sort_by=contract_name&country_code=ao

Get Annotation by ID
/annotation/{id}

Get Recently Published Contracts
/contracts/recent

Get Recent Contract Count
/contracts/recent/count

Download Annotations as CSV
/contract/{id}/annotations/download

Get Countries Contracts
/contract/countries

Get Resource Contracts
/contract/resources

Get Years Contracts
/contract/years

Get Contract by Country and Resource
/contract/country/resource

Get Filter Attributes
/contract/attributes

Get Annotations Category
/contracts/annotations/category

Download Metadata as CSV
/contracts/metadata/download