GET /api/v2/entities
List Entities

Examples

GET /api/v2/entities
200
{
  "data": [
    {
      "id": "511",
      "type": "entities",
      "links": {
        "self": "http://test.host/api/v2/entities/511"
      },
      "attributes": {
        "short-name": "CANON INC",
        "bbgid": "BBG0100209FO",
        "country": "Singapore",
        "sector": "Healthcare",
        "security": "CANON US EQUITY",
        "google-finance-ticker": "ABC:DEF",
        "slug": "canon-inc",
        "entity-description": null,
        "isin": null,
        "exchange-code": "US",
        "total-watchers": 0,
        "ric-ticker": null,
        "yahoo-ticker": null,
        "company-size": null,
        "market-cap": null,
        "is-macro": false,
        "introduced-total-watchlists": 0
      },
      "relationships": {
        "entity-stat": {
          "links": {
            "self": "http://test.host/api/v2/entities/511/relationships/entity-stat",
            "related": "http://test.host/api/v2/entities/511/entity-stat"
          }
        },
        "insights": {
          "links": {
            "self": "http://test.host/api/v2/entities/511/relationships/insights",
            "related": "http://test.host/api/v2/entities/511/insights"
          }
        },
        "watchlists": {
          "links": {
            "self": "http://test.host/api/v2/entities/511/relationships/watchlists",
            "related": "http://test.host/api/v2/entities/511/watchlists"
          }
        },
        "gic-sector": {
          "links": {
            "self": "http://test.host/api/v2/entities/511/relationships/gic-sector",
            "related": "http://test.host/api/v2/entities/511/gic-sector"
          }
        },
        "images": {
          "links": {
            "self": "http://test.host/api/v2/entities/511/relationships/images",
            "related": "http://test.host/api/v2/entities/511/images"
          }
        },
        "insight-documents": {
          "links": {
            "self": "http://test.host/api/v2/entities/511/relationships/insight-documents",
            "related": "http://test.host/api/v2/entities/511/insight-documents"
          }
        },
        "locker-items": {
          "links": {
            "self": "http://test.host/api/v2/entities/511/relationships/locker-items",
            "related": "http://test.host/api/v2/entities/511/locker-items"
          }
        },
        "primary-insights": {
          "links": {
            "self": "http://test.host/api/v2/entities/511/relationships/primary-insights",
            "related": "http://test.host/api/v2/entities/511/primary-insights"
          }
        },
        "publications": {
          "links": {
            "self": "http://test.host/api/v2/entities/511/relationships/publications",
            "related": "http://test.host/api/v2/entities/511/publications"
          }
        },
        "primary-publications": {
          "links": {
            "self": "http://test.host/api/v2/entities/511/relationships/primary-publications",
            "related": "http://test.host/api/v2/entities/511/primary-publications"
          }
        },
        "secondary-publications": {
          "links": {
            "self": "http://test.host/api/v2/entities/511/relationships/secondary-publications",
            "related": "http://test.host/api/v2/entities/511/secondary-publications"
          }
        },
        "exchange-announcements": {
          "links": {
            "self": "http://test.host/api/v2/entities/511/relationships/exchange-announcements",
            "related": "http://test.host/api/v2/entities/511/exchange-announcements"
          }
        },
        "comment-threads": {
          "links": {
            "self": "http://test.host/api/v2/entities/511/relationships/comment-threads",
            "related": "http://test.host/api/v2/entities/511/comment-threads"
          }
        },
        "benchmarking-reports": {
          "links": {
            "self": "http://test.host/api/v2/entities/511/relationships/benchmarking-reports",
            "related": "http://test.host/api/v2/entities/511/benchmarking-reports"
          }
        }
      }
    },
    {
      "id": "512",
      "type": "entities",
      "links": {
        "self": "http://test.host/api/v2/entities/512"
      },
      "attributes": {
        "short-name": "APPLE INC",
        "bbgid": "BBG0100210TC",
        "country": "Singapore",
        "sector": "Energy",
        "security": "APPLE US EQUITY",
        "google-finance-ticker": "NASDAQ:AAPL",
        "slug": "apple-inc",
        "entity-description": null,
        "isin": null,
        "exchange-code": "US",
        "total-watchers": 0,
        "ric-ticker": null,
        "yahoo-ticker": null,
        "company-size": null,
        "market-cap": null,
        "is-macro": false,
        "introduced-total-watchlists": 0
      },
      "relationships": {
        "entity-stat": {
          "links": {
            "self": "http://test.host/api/v2/entities/512/relationships/entity-stat",
            "related": "http://test.host/api/v2/entities/512/entity-stat"
          }
        },
        "insights": {
          "links": {
            "self": "http://test.host/api/v2/entities/512/relationships/insights",
            "related": "http://test.host/api/v2/entities/512/insights"
          }
        },
        "watchlists": {
          "links": {
            "self": "http://test.host/api/v2/entities/512/relationships/watchlists",
            "related": "http://test.host/api/v2/entities/512/watchlists"
          }
        },
        "gic-sector": {
          "links": {
            "self": "http://test.host/api/v2/entities/512/relationships/gic-sector",
            "related": "http://test.host/api/v2/entities/512/gic-sector"
          }
        },
        "images": {
          "links": {
            "self": "http://test.host/api/v2/entities/512/relationships/images",
            "related": "http://test.host/api/v2/entities/512/images"
          }
        },
        "insight-documents": {
          "links": {
            "self": "http://test.host/api/v2/entities/512/relationships/insight-documents",
            "related": "http://test.host/api/v2/entities/512/insight-documents"
          }
        },
        "locker-items": {
          "links": {
            "self": "http://test.host/api/v2/entities/512/relationships/locker-items",
            "related": "http://test.host/api/v2/entities/512/locker-items"
          }
        },
        "primary-insights": {
          "links": {
            "self": "http://test.host/api/v2/entities/512/relationships/primary-insights",
            "related": "http://test.host/api/v2/entities/512/primary-insights"
          }
        },
        "publications": {
          "links": {
            "self": "http://test.host/api/v2/entities/512/relationships/publications",
            "related": "http://test.host/api/v2/entities/512/publications"
          }
        },
        "primary-publications": {
          "links": {
            "self": "http://test.host/api/v2/entities/512/relationships/primary-publications",
            "related": "http://test.host/api/v2/entities/512/primary-publications"
          }
        },
        "secondary-publications": {
          "links": {
            "self": "http://test.host/api/v2/entities/512/relationships/secondary-publications",
            "related": "http://test.host/api/v2/entities/512/secondary-publications"
          }
        },
        "exchange-announcements": {
          "links": {
            "self": "http://test.host/api/v2/entities/512/relationships/exchange-announcements",
            "related": "http://test.host/api/v2/entities/512/exchange-announcements"
          }
        },
        "comment-threads": {
          "links": {
            "self": "http://test.host/api/v2/entities/512/relationships/comment-threads",
            "related": "http://test.host/api/v2/entities/512/comment-threads"
          }
        },
        "benchmarking-reports": {
          "links": {
            "self": "http://test.host/api/v2/entities/512/relationships/benchmarking-reports",
            "related": "http://test.host/api/v2/entities/512/benchmarking-reports"
          }
        }
      }
    },
    {
      "id": "513",
      "type": "entities",
      "links": {
        "self": "http://test.host/api/v2/entities/513"
      },
      "attributes": {
        "short-name": "JAPAN MATERIAL",
        "bbgid": "BBG0100211SR",
        "country": "Japan",
        "sector": "Materials",
        "security": "MWZYVG6 CH EQUITY",
        "google-finance-ticker": "MYSTRING",
        "slug": "japan-material",
        "entity-description": null,
        "isin": null,
        "exchange-code": "CH",
        "total-watchers": 0,
        "ric-ticker": null,
        "yahoo-ticker": null,
        "company-size": null,
        "market-cap": null,
        "is-macro": false,
        "introduced-total-watchlists": 0
      },
      "relationships": {
        "entity-stat": {
          "links": {
            "self": "http://test.host/api/v2/entities/513/relationships/entity-stat",
            "related": "http://test.host/api/v2/entities/513/entity-stat"
          }
        },
        "insights": {
          "links": {
            "self": "http://test.host/api/v2/entities/513/relationships/insights",
            "related": "http://test.host/api/v2/entities/513/insights"
          }
        },
        "watchlists": {
          "links": {
            "self": "http://test.host/api/v2/entities/513/relationships/watchlists",
            "related": "http://test.host/api/v2/entities/513/watchlists"
          }
        },
        "gic-sector": {
          "links": {
            "self": "http://test.host/api/v2/entities/513/relationships/gic-sector",
            "related": "http://test.host/api/v2/entities/513/gic-sector"
          }
        },
        "images": {
          "links": {
            "self": "http://test.host/api/v2/entities/513/relationships/images",
            "related": "http://test.host/api/v2/entities/513/images"
          }
        },
        "insight-documents": {
          "links": {
            "self": "http://test.host/api/v2/entities/513/relationships/insight-documents",
            "related": "http://test.host/api/v2/entities/513/insight-documents"
          }
        },
        "locker-items": {
          "links": {
            "self": "http://test.host/api/v2/entities/513/relationships/locker-items",
            "related": "http://test.host/api/v2/entities/513/locker-items"
          }
        },
        "primary-insights": {
          "links": {
            "self": "http://test.host/api/v2/entities/513/relationships/primary-insights",
            "related": "http://test.host/api/v2/entities/513/primary-insights"
          }
        },
        "publications": {
          "links": {
            "self": "http://test.host/api/v2/entities/513/relationships/publications",
            "related": "http://test.host/api/v2/entities/513/publications"
          }
        },
        "primary-publications": {
          "links": {
            "self": "http://test.host/api/v2/entities/513/relationships/primary-publications",
            "related": "http://test.host/api/v2/entities/513/primary-publications"
          }
        },
        "secondary-publications": {
          "links": {
            "self": "http://test.host/api/v2/entities/513/relationships/secondary-publications",
            "related": "http://test.host/api/v2/entities/513/secondary-publications"
          }
        },
        "exchange-announcements": {
          "links": {
            "self": "http://test.host/api/v2/entities/513/relationships/exchange-announcements",
            "related": "http://test.host/api/v2/entities/513/exchange-announcements"
          }
        },
        "comment-threads": {
          "links": {
            "self": "http://test.host/api/v2/entities/513/relationships/comment-threads",
            "related": "http://test.host/api/v2/entities/513/comment-threads"
          }
        },
        "benchmarking-reports": {
          "links": {
            "self": "http://test.host/api/v2/entities/513/relationships/benchmarking-reports",
            "related": "http://test.host/api/v2/entities/513/benchmarking-reports"
          }
        }
      }
    }
  ],
  "meta": {
    "total-pages": 1,
    "record-count": 3
  },
  "links": {
    "first": "http://test.host/api/v2/entities?page%5Bnumber%5D=1&page%5Bsize%5D=10",
    "last": "http://test.host/api/v2/entities?page%5Bnumber%5D=1&page%5Bsize%5D=10"
  }
}

GET /api/v2/entities/:id
Show a Entity

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.


PATCH /api/v1/entities/:id
Update an entity

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.

data
required

Entity information

Validations:

  • Must be a Hash

data[type]
optional

Validations:

data[attributes]
optional

Validations:

  • Must be a Hash

data[attributes][short-name]
optional

Validations:

  • Must be a String

data[attributes][pretty-name]
optional

Validations:

  • Must be a String

data[attributes][entity-description]
optional , nil allowed

Validations:

  • Must be a String

data[attributes][logo]
optional , nil allowed

Entity's logo file in data URL format

Validations:

  • Must be a String

data[attributes][logo-file-name]
optional , nil allowed

Entity's logo file name

Validations:

  • Must be a String

data[attributes][country]
optional

Validations:

  • Must be a String

data[attributes][contact-info]
optional , nil allowed

Entity's contact information

Validations:

  • Must be a Hash

data[attributes][contact-info][email]
optional , nil allowed

Official email of the entity

Validations:

  • Must be a String

data[attributes][contact-info][website]
optional , nil allowed

Official website of the entity

Validations:

  • Must be a String

data[attributes][contact-info][street-address]
optional , nil allowed

The street address of the entity

Validations:

  • Must be a String

data[attributes][contact-info][postal-code]
optional , nil allowed

The postal code of the entity

Validations:

  • Must be a String

data[attributes][contact-info][city]
optional , nil allowed

The city of the entity

Validations:

  • Must be a String

data[attributes][contact-info][phone-number]
optional , nil allowed

The phone number of the entity

Validations:

  • Must be a String

data[attributes][country-of-primary-listing]
optional , nil allowed

Validations:

  • Must be a String

data[attributes][investor-relation-info]
optional , nil allowed

Entity's investor relation information

Validations:

  • Must be a Hash

data[attributes][investor-relation-info][ir-email]
optional , nil allowed

Official email of the entity IR

Validations:

  • Must be a String

data[attributes][investor-relation-info][ir-website]
optional , nil allowed

Official website of the entity IR

Validations:

  • Must be a String

data[attributes][investor-relation-info][ir-info]
optional , nil allowed

Official information of the entity IR

Validations:

  • Must be a String


PATCH /apiv2/entities/:id/add_peers
Add peer entities to the entity

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.

data
required

Entity information

Validations:

  • Must be a Hash

data[type]
optional

Validations:

data[attributes]
optional

Validations:

  • Must be a Hash

data[attributes][short-name]
optional

Validations:

  • Must be a String

data[attributes][pretty-name]
optional

Validations:

  • Must be a String

data[attributes][entity-description]
optional , nil allowed

Validations:

  • Must be a String

data[attributes][logo]
optional , nil allowed

Entity's logo file in data URL format

Validations:

  • Must be a String

data[attributes][logo-file-name]
optional , nil allowed

Entity's logo file name

Validations:

  • Must be a String

data[attributes][country]
optional

Validations:

  • Must be a String

data[attributes][contact-info]
optional , nil allowed

Entity's contact information

Validations:

  • Must be a Hash

data[attributes][contact-info][email]
optional , nil allowed

Official email of the entity

Validations:

  • Must be a String

data[attributes][contact-info][website]
optional , nil allowed

Official website of the entity

Validations:

  • Must be a String

data[attributes][contact-info][street-address]
optional , nil allowed

The street address of the entity

Validations:

  • Must be a String

data[attributes][contact-info][postal-code]
optional , nil allowed

The postal code of the entity

Validations:

  • Must be a String

data[attributes][contact-info][city]
optional , nil allowed

The city of the entity

Validations:

  • Must be a String

data[attributes][contact-info][phone-number]
optional , nil allowed

The phone number of the entity

Validations:

  • Must be a String

data[attributes][country-of-primary-listing]
optional , nil allowed

Validations:

  • Must be a String

data[attributes][investor-relation-info]
optional , nil allowed

Entity's investor relation information

Validations:

  • Must be a Hash

data[attributes][investor-relation-info][ir-email]
optional , nil allowed

Official email of the entity IR

Validations:

  • Must be a String

data[attributes][investor-relation-info][ir-website]
optional , nil allowed

Official website of the entity IR

Validations:

  • Must be a String

data[attributes][investor-relation-info][ir-info]
optional , nil allowed

Official information of the entity IR

Validations:

  • Must be a String


PATCH /apiv2/entities/:id/remove_peers
Remove peer entities to the entity

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.

data
required

Entity information

Validations:

  • Must be a Hash

data[type]
optional

Validations:

data[attributes]
optional

Validations:

  • Must be a Hash

data[attributes][short-name]
optional

Validations:

  • Must be a String

data[attributes][pretty-name]
optional

Validations:

  • Must be a String

data[attributes][entity-description]
optional , nil allowed

Validations:

  • Must be a String

data[attributes][logo]
optional , nil allowed

Entity's logo file in data URL format

Validations:

  • Must be a String

data[attributes][logo-file-name]
optional , nil allowed

Entity's logo file name

Validations:

  • Must be a String

data[attributes][country]
optional

Validations:

  • Must be a String

data[attributes][contact-info]
optional , nil allowed

Entity's contact information

Validations:

  • Must be a Hash

data[attributes][contact-info][email]
optional , nil allowed

Official email of the entity

Validations:

  • Must be a String

data[attributes][contact-info][website]
optional , nil allowed

Official website of the entity

Validations:

  • Must be a String

data[attributes][contact-info][street-address]
optional , nil allowed

The street address of the entity

Validations:

  • Must be a String

data[attributes][contact-info][postal-code]
optional , nil allowed

The postal code of the entity

Validations:

  • Must be a String

data[attributes][contact-info][city]
optional , nil allowed

The city of the entity

Validations:

  • Must be a String

data[attributes][contact-info][phone-number]
optional , nil allowed

The phone number of the entity

Validations:

  • Must be a String

data[attributes][country-of-primary-listing]
optional , nil allowed

Validations:

  • Must be a String

data[attributes][investor-relation-info]
optional , nil allowed

Entity's investor relation information

Validations:

  • Must be a Hash

data[attributes][investor-relation-info][ir-email]
optional , nil allowed

Official email of the entity IR

Validations:

  • Must be a String

data[attributes][investor-relation-info][ir-website]
optional , nil allowed

Official website of the entity IR

Validations:

  • Must be a String

data[attributes][investor-relation-info][ir-info]
optional , nil allowed

Official information of the entity IR

Validations:

  • Must be a String