Back to top

Catena public API

Catena logo

  • Current Version: 1.0

  • For changes, see History

This document describes the public Catena REST API.

Disclosures

Disclosure Retrieve

Disclosure Retrieve
GET/api/v1/public/disclosures/{id}{?lng}

Get a single disclosure by id.

Example URI

GET https://api.explorecatena.com/api/v1/public/disclosures/kkzxVXzBbnFyBNkD3Zv6tbPJxO6wOL?lng=en
URI Parameters
HideShow
id
string (required) Example: kkzxVXzBbnFyBNkD3Zv6tbPJxO6wOL

The unique ID of a disclosure

lng
string (optional) Example: en

Language to localize results by. This will merge the data in localized.{lng} into the base disclosure object and remove the original localized field from the response.

Choices: en fr

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "date": "2016-Q3",
  "amount": 350000,
  "localized": {
    "en": {
      "address": {
        "country": "Canada",
        "region": "Ontario",
        "city": "Ottawa"
      },
      "organization": "National Research Council Canada",
      "recipient": "Bitaccess Inc.",
      "fundingType": "Contribution",
      "purpose": "To support a firm in the \"Computer and peripheral equipment manufacturing\" industry (NAICS: 334110) with a research and development project."
    },
    "fr": {
      "address": {
        "country": "Canada",
        "region": "Ontario",
        "city": "Ottawa"
      },
      "organization": "Conseil national de recherches Canada",
      "recipient": "Bitaccess Inc.",
      "fundingType": "contributions",
      "purpose": "Pour supporter une compagnie dans le secteur \"Fabrication de matériel informatique et périphérique\" (SCIAN: 334110) dans un projet de recherche et développment"
    }
  },
  "location": {
    "countryCode": "CA",
    "regionCode": "ON"
  },
  "blockchain": {
    "txId": "0x630df6ea52c81a81eddb7c994ee8da6038b6e433201827af9f95b9db91c12a3b",
    "networkId": "1",
    "blockNumber": 4587573,
    "blockTimestamp": 1511169615,
    "rowNumber": 955,
    "contractAddress": "0xff77e51f2c6473f72392865e0a0000de19af774a"
  },
  "id": "kkzxVXzBbnFyBNkD3Zv6tbPJxO6wOL"
}

Disclosure List

Disclosure List
GET/api/v1/public/disclosures{?q,sortField,sortDir,limit,page,lng}

List or search for published disclosures matching a query with options for sorting, pagination, and localization.

Example URI

GET https://api.explorecatena.com/api/v1/public/disclosures?q=bit&sortField=blockchain.rowNumber&sortDir=asc&limit=20&page=3&lng=en
URI Parameters
HideShow
q
string (optional) Example: bit

Search query

sortField
string (optional) Default: amount Example: blockchain.rowNumber

Sort results by this field

sortDir
string (optional) Default: desc Example: asc

What direction to sort by

Choices: 1 -1 asc desc ascending descending

limit
integer (optional) Default: 10 Example: 20

The maximum number of results to return, up to 100

page
integer (optional) Default: 1 Example: 3

The page to return in results

lng
string (optional) Example: en

Language to localize results by. This will merge the data in localized.{lng} into the base disclosure object and remove the original localized field from the response.

Choices: en fr

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "total": 3053,
  "results": [
    {
      "date": "2016-Q1",
      "amount": 150000,
      "localized": {
        "en": {
          "address": {
            "country": "Canada",
            "region": "Manitoba",
            "city": "Winnipeg"
          },
          "organization": "National Research Council Canada",
          "recipient": "151 Research Inc.",
          "fundingType": "Contribution",
          "purpose": "To support a firm in the \"Computer systems design and related services\" industry (NAICS: 54151) with a research and development project."
        },
        "fr": {
          "address": {
            "country": "Canada",
            "region": "Manitoba",
            "city": "Winnipeg"
          },
          "organization": "Conseil national de recherches Canada",
          "recipient": "151 Research Inc.",
          "fundingType": "contributions",
          "purpose": "Pour supporter une compagnie dans le secteur \"Conception de systèmes informatiques et services connexes\" (SCIAN: 54151) dans un projet de recherche et développment"
        }
      },
      "location": {
        "countryCode": "CA",
        "regionCode": "MB"
      },
      "blockchain": {
        "txId": "0x6606e9bd270a6dc06b88a21bd0b0f66283cbcab627a40df15ce5857eca107c92",
        "networkId": "1",
        "blockNumber": 4586862,
        "blockTimestamp": 1511159964,
        "rowNumber": 1,
        "contractAddress": "0xff77e51f2c6473f72392865e0a0000de19af774a"
      },
      "id": "AYp630p8zDsRKBawVgJZS9AvLJaGJ0"
    },
    {
      "date": "2016-Q1",
      "amount": 31374,
      "localized": {
        "en": {
          "address": {
            "country": "Canada",
            "region": "Ontario",
            "city": "Beamsville"
          },
          "organization": "National Research Council Canada",
          "recipient": "1546866 Ontario Inc.",
          "fundingType": "Contribution",
          "purpose": "To support a firm in the \"All other building equipment contractors\" industry (NAICS: 238299) with a research and development project."
        },
        "fr": {
          "address": {
            "country": "Canada",
            "region": "Ontario",
            "city": "Beamsville"
          },
          "organization": "Conseil national de recherches Canada",
          "recipient": "1546866 Ontario Inc.",
          "fundingType": "contributions",
          "purpose": "Pour supporter une compagnie dans le secteur \"Entrepreneurs en installation de tout autre équipement technique\" (SCIAN: 238299) dans un projet de recherche et développment"
        }
      },
      "location": {
        "countryCode": "CA",
        "regionCode": "ON"
      },
      "blockchain": {
        "txId": "0x4f4854f477ecf0dcd1edc24f582b3d90667443c47864f01512907817620fdce1",
        "networkId": "1",
        "blockNumber": 4586862,
        "blockTimestamp": 1511159964,
        "rowNumber": 2,
        "contractAddress": "0xff77e51f2c6473f72392865e0a0000de19af774a"
      },
      "id": "R4dZwldNYetp97AvDAgLFrkgaZRwZp"
    }
  ],
  "page": 1,
  "limit": 2,
  "pages": 1527
}

Disclosure List DataTables

Disclosure List DataTables
GET/api/v1/public/datatables/disclosures

Same functionality as the Disclosure List endpoint but with an interface compatible with the DataTables library

Example URI

GET https://api.explorecatena.com/api/v1/public/datatables/disclosures
Response  200
HideShow
Headers
Content-Type: application/json

History

Version 1.0:

  • disclosures list/search endpoint added

  • disclosures list/search datatables endpoint added

  • disclosures retrieve endpoint added

Generated by aglio on 12 Oct 2018