Examples

GET /api/v2/entities/504
200
{
  "data": {
    "id": "504",
    "type": "entities",
    "links": {
      "self": "http://test.host/api/v2/entities/504"
    },
    "attributes": {
      "short-name": "CANON INC",
      "bbgid": "BBG0100202SM",
      "country": "Singapore",
      "sector": "Healthcare",
      "security": "CANON US EQUITY",
      "google-finance-ticker": "ABC:DEF",
      "slug": "canon-inc",
      "entity-description": null,
      "isin": null,
      "total-bearish": 0,
      "total-bullish": 0,
      "exchange-code": "US",
      "total-insights": 0,
      "total-watchers": 0,
      "total-insight-views": 0,
      "ric-ticker": null,
      "yahoo-ticker": null,
      "company-size": null,
      "market-cap": null,
      "is-macro": false,
      "total-insight-providers": 0,
      "introduced-total-watchlists": 0,
      "has-primary-insights": false,
      "has-primary-external-reports": false
    },
    "relationships": {
      "entity-stat": {
        "links": {
          "self": "http://test.host/api/v2/entities/504/relationships/entity-stat",
          "related": "http://test.host/api/v2/entities/504/entity-stat"
        }
      },
      "insights": {
        "links": {
          "self": "http://test.host/api/v2/entities/504/relationships/insights",
          "related": "http://test.host/api/v2/entities/504/insights"
        }
      },
      "watchlists": {
        "links": {
          "self": "http://test.host/api/v2/entities/504/relationships/watchlists",
          "related": "http://test.host/api/v2/entities/504/watchlists"
        }
      },
      "gic-sector": {
        "links": {
          "self": "http://test.host/api/v2/entities/504/relationships/gic-sector",
          "related": "http://test.host/api/v2/entities/504/gic-sector"
        }
      },
      "images": {
        "links": {
          "self": "http://test.host/api/v2/entities/504/relationships/images",
          "related": "http://test.host/api/v2/entities/504/images"
        }
      },
      "insight-documents": {
        "links": {
          "self": "http://test.host/api/v2/entities/504/relationships/insight-documents",
          "related": "http://test.host/api/v2/entities/504/insight-documents"
        }
      },
      "locker-items": {
        "links": {
          "self": "http://test.host/api/v2/entities/504/relationships/locker-items",
          "related": "http://test.host/api/v2/entities/504/locker-items"
        }
      },
      "primary-insights": {
        "links": {
          "self": "http://test.host/api/v2/entities/504/relationships/primary-insights",
          "related": "http://test.host/api/v2/entities/504/primary-insights"
        }
      },
      "publications": {
        "links": {
          "self": "http://test.host/api/v2/entities/504/relationships/publications",
          "related": "http://test.host/api/v2/entities/504/publications"
        }
      },
      "primary-publications": {
        "links": {
          "self": "http://test.host/api/v2/entities/504/relationships/primary-publications",
          "related": "http://test.host/api/v2/entities/504/primary-publications"
        }
      },
      "secondary-publications": {
        "links": {
          "self": "http://test.host/api/v2/entities/504/relationships/secondary-publications",
          "related": "http://test.host/api/v2/entities/504/secondary-publications"
        }
      },
      "exchange-announcements": {
        "links": {
          "self": "http://test.host/api/v2/entities/504/relationships/exchange-announcements",
          "related": "http://test.host/api/v2/entities/504/exchange-announcements"
        }
      },
      "comment-threads": {
        "links": {
          "self": "http://test.host/api/v2/entities/504/relationships/comment-threads",
          "related": "http://test.host/api/v2/entities/504/comment-threads"
        }
      },
      "benchmarking-reports": {
        "links": {
          "self": "http://test.host/api/v2/entities/504/relationships/benchmarking-reports",
          "related": "http://test.host/api/v2/entities/504/benchmarking-reports"
        }
      }
    }
  }
}

Params

Param name Description
id
required

Entity ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.