You can use the following query to return all clauses.
curl -H X-API-Key: YOUR_API_KEY https://api.acuris.com/transaction-clauses/clauses
The q parameter enables Boolean filtering of the response using combinations of metadata points and text searches. Expressions take the form of field:value pairs separated by spaces and the Boolean terms AND, OR, NOT. Parenthesis () can be used to logically group terms together. A full list of fields available is under [link – Query fields] in the Query Parameters section.
curl -X GET "https://api.acuris.com/transaction-clauses/clauses?q=clauseType:1933 AND clauseText:responsibility”
The clauseText field is unique in that it enables you enter additional text search Boolean within its value pairing.
curl -X GET "https://api.acuris.com/transaction-clauses /clauses?q=clauseText:((Bond OR Certificate) AND "British Airways") AND clauseType:1933”
issueDate, transactionSize and coupon fields can be queried by date range, an asterisk * wild card can be used to express maximum upper or lower limit.
curl -X GET "https://api.acuris.com/transaction-clauses /clauses?q=issueDate:[2020-09-01 TO *]
Reference data
For a given field, a full reference of names and corresponding ids can be accessed under its reference data endpoint. For example, for a full list of countries and corresponding id numbers, you can use the following:
curl -X GET " https://api.acuris.com/transaction-clauses/reference-data/countries”
To search within reference data, use the name parameter. For example, the following will match all companies with the string ‘voda’ anywhere in their name:
curl -X GET "https://api.acuris.com/transaction-clauses/reference-data/ companies?name=voda”
Pagination
Results are returned by the API in blocks of maximum 100 items per page. A page size of 20 or less is recommended for performance. To navigate to the nextPage, you can use the link found in the paging section found at the end of the payload.
"paging": {
"nextPage": "https://api.acuris.com/transaction-clauses/Clauses?pageToken=FGluY2x1ZGVfY29udGV4dF91dWlkDnF1ZXJ5VGhlbkZldGNoBRQzTVF6VkhRQmxJQmRSVnJmWHpSRgAAAAAACyw8Fk1XVUpza1lSUUttRU1JektKakJRSWcUSUZzelZIUUJiN25uTUR5bFhZNFAAAAAAAAso_hZDS3NPcEYxRFRsYWM5Q3NFZXR3a2RRFElWc3pWSFFCYjdubk1EeWxYWTVWAAAAAAALKP8WQ0tzT3BGMURUbGFjOUNzRWV0d2tkURRJbHN6VkhRQmI3bm5NRHlsWFk2SQAAAAAACykAFkNLc09wRjFEVGxhYzlDc0VldHdrZFEUSTFzelZIUUJiN25uTUR5bFhZNjUAAAAAAAspARZDS3NPcEYxRFRsYWM5Q3NFZXR3a2RR"
}
Alternatively, to go to a specific page, you can use the pageToken parameter:
curl -X GET "https://api.acuris.com/transaction-clauses/clauses?pageToken=FGluY2x1ZGVfY29udGV4dF91dWlkDnF1ZXJ5VGhlbkZldGNoBRQzTVF6VkhRQmxJQmRSVnJmWHpSRgAAAAAACyw8Fk1XVUpza1lSUUttRU1JektKakJRSWcUSUZzelZIUUJiN25uTUR5bFhZNFAAAAAAAAso_hZDS3NPcEYxRFRsYWM5Q3NFZXR3a2RRFElWc3pWSFFCYjdubk1EeWxYWTVWAAAAAAALKP8WQ0tzT3BGMURUbGFjOUNzRWV0d2tkURRJbHN6VkhRQmI3bm5NRHlsWFk2SQAAAAAACykAFkNLc09wRjFEVGxhYzlDc0VldHdrZFEUSTFzelZIUUJiN25uTUR5bFhZNjUAAAAAAAspARZDS3NPcEYxRFRsYWM5Q3NFZXR3a2RR