GET v1/Entities/Search

Search for an entity using name, PID, MoodysOrgId, ticker, ticker@exchange, CUSIP, ISIN, Figi, Lei, or Sedol.

Request Information

Parameters

Name	Type	Description	Additional information
request	EntitySearchRequest	Container for the Entity Search Request input parameters. See parameter details below.	Define this parameter in the request URI.

Parameter Information

Parameter Name: request

Property	Type	Description
Query	String	Search for an Entity by name, PID, ticker, CUSIP, or ISIN.
MaxResults	Int32	Specifies the maximum number of records to return. This field is optional. The default is 10.
SdkVersion	String	If the client is using the SDK, the version number will be passed along with the request. This field is optional.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "entities": [
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "entityType": "Public",
      "tickerSymbol": "sample string 3",
      "countryCode": "sample string 4",
      "industryCode": "sample string 5",
      "sicCode": "sample string 6",
      "naicsCode": "sample string 7",
      "cusip": "sample string 8",
      "moodysOrgId": "sample string 9",
      "regionCode": "sample string 10",
      "isin": "sample string 11",
      "figi": "sample string 12",
      "lei": "sample string 13"
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "entityType": "Public",
      "tickerSymbol": "sample string 3",
      "countryCode": "sample string 4",
      "industryCode": "sample string 5",
      "sicCode": "sample string 6",
      "naicsCode": "sample string 7",
      "cusip": "sample string 8",
      "moodysOrgId": "sample string 9",
      "regionCode": "sample string 10",
      "isin": "sample string 11",
      "figi": "sample string 12",
      "lei": "sample string 13"
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "entityType": "Public",
      "tickerSymbol": "sample string 3",
      "countryCode": "sample string 4",
      "industryCode": "sample string 5",
      "sicCode": "sample string 6",
      "naicsCode": "sample string 7",
      "cusip": "sample string 8",
      "moodysOrgId": "sample string 9",
      "regionCode": "sample string 10",
      "isin": "sample string 11",
      "figi": "sample string 12",
      "lei": "sample string 13"
    }
  ],
  "errorOccurred": false,
  "errorMessages": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "request": {
    "query": "sample string 1",
    "maxResults": 2,
    "sdkVersion": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<EntitySearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </ErrorMessages>
  <ErrorOccurred>false</ErrorOccurred>
  <Request>
    <SdkVersion>sample string 3</SdkVersion>
    <MaxResults>2</MaxResults>
    <Query>sample string 1</Query>
  </Request>
  <Entities>
    <Entity>
      <CountryCode>sample string 4</CountryCode>
      <Cusip>sample string 8</Cusip>
      <EntityType>Public</EntityType>
      <Figi>sample string 12</Figi>
      <Id>sample string 1</Id>
      <IndustryCode>sample string 5</IndustryCode>
      <Isin>sample string 11</Isin>
      <Lei>sample string 13</Lei>
      <MoodysOrgId>sample string 9</MoodysOrgId>
      <NaicsCode>sample string 7</NaicsCode>
      <Name>sample string 2</Name>
      <RegionCode>sample string 10</RegionCode>
      <SicCode>sample string 6</SicCode>
      <TickerSymbol>sample string 3</TickerSymbol>
    </Entity>
    <Entity>
      <CountryCode>sample string 4</CountryCode>
      <Cusip>sample string 8</Cusip>
      <EntityType>Public</EntityType>
      <Figi>sample string 12</Figi>
      <Id>sample string 1</Id>
      <IndustryCode>sample string 5</IndustryCode>
      <Isin>sample string 11</Isin>
      <Lei>sample string 13</Lei>
      <MoodysOrgId>sample string 9</MoodysOrgId>
      <NaicsCode>sample string 7</NaicsCode>
      <Name>sample string 2</Name>
      <RegionCode>sample string 10</RegionCode>
      <SicCode>sample string 6</SicCode>
      <TickerSymbol>sample string 3</TickerSymbol>
    </Entity>
    <Entity>
      <CountryCode>sample string 4</CountryCode>
      <Cusip>sample string 8</Cusip>
      <EntityType>Public</EntityType>
      <Figi>sample string 12</Figi>
      <Id>sample string 1</Id>
      <IndustryCode>sample string 5</IndustryCode>
      <Isin>sample string 11</Isin>
      <Lei>sample string 13</Lei>
      <MoodysOrgId>sample string 9</MoodysOrgId>
      <NaicsCode>sample string 7</NaicsCode>
      <Name>sample string 2</Name>
      <RegionCode>sample string 10</RegionCode>
      <SicCode>sample string 6</SicCode>
      <TickerSymbol>sample string 3</TickerSymbol>
    </Entity>
  </Entities>
</EntitySearchResponse>