GET v1/Entities/Mapping

The same as Search but instead of using a broad search you can enter request identifier of specific type to post to the server. Mapping entity by a specific identifier type is generally faster than using a broad search.

Request Information

Parameters

Name	Type	Description	Additional information
request	EntityMappingRequest	Container for the Entity Mapping 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 its name, PID, MoodysOrgId, ticker, ticker@exchange, CUSIP, ISIN, Figi, Lei, or Sedol.
MaxResults	Int32	Specifies the maximum number of records to return. This field is optional. The default is 10.
MappingType	SearchType	Specifies the type of query identifier to search for. This field is required. The default is 1 for "PID". The following types can be used: 0 - All of the below, broad search 1 - PID 2 - Company Name (fuzzy search, not unique) 3 - Equity Cusip 4 - Equity ISIN 5 - Ticker 5 - Ticker and Exchange, specify query value in Ticker@Exchange format 6 - Sedol 7 - Bond Cusip 8 - Bond ISIN 9 - Bond Symbol 12 - LEI 13 - FiGi 14 - Moody's Org ID for rated entities
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",
      "parentId": "sample string 2",
      "name": "sample string 3",
      "ticker": "sample string 4",
      "exchange": "sample string 5",
      "entityType": "All",
      "organizationType": "Public",
      "cusip": "sample string 6",
      "isin": "sample string 7",
      "countryCode": "sample string 8",
      "regionCode": "sample string 9",
      "industryCode": "sample string 10",
      "sectorCode": "sample string 11",
      "sicCode": "sample string 12",
      "naicsCode": "sample string 13",
      "moodysOrgId": "sample string 14",
      "bloombergId": 15,
      "sedol": "sample string 16",
      "lei": "sample string 17",
      "fiGi": "sample string 18",
      "hooverCode": "sample string 19",
      "webSite": "sample string 20",
      "isMarkitAuthorized": false,
      "requiresSubscription": false,
      "requestID": 23
    },
    {
      "id": "sample string 1",
      "parentId": "sample string 2",
      "name": "sample string 3",
      "ticker": "sample string 4",
      "exchange": "sample string 5",
      "entityType": "All",
      "organizationType": "Public",
      "cusip": "sample string 6",
      "isin": "sample string 7",
      "countryCode": "sample string 8",
      "regionCode": "sample string 9",
      "industryCode": "sample string 10",
      "sectorCode": "sample string 11",
      "sicCode": "sample string 12",
      "naicsCode": "sample string 13",
      "moodysOrgId": "sample string 14",
      "bloombergId": 15,
      "sedol": "sample string 16",
      "lei": "sample string 17",
      "fiGi": "sample string 18",
      "hooverCode": "sample string 19",
      "webSite": "sample string 20",
      "isMarkitAuthorized": false,
      "requiresSubscription": false,
      "requestID": 23
    },
    {
      "id": "sample string 1",
      "parentId": "sample string 2",
      "name": "sample string 3",
      "ticker": "sample string 4",
      "exchange": "sample string 5",
      "entityType": "All",
      "organizationType": "Public",
      "cusip": "sample string 6",
      "isin": "sample string 7",
      "countryCode": "sample string 8",
      "regionCode": "sample string 9",
      "industryCode": "sample string 10",
      "sectorCode": "sample string 11",
      "sicCode": "sample string 12",
      "naicsCode": "sample string 13",
      "moodysOrgId": "sample string 14",
      "bloombergId": 15,
      "sedol": "sample string 16",
      "lei": "sample string 17",
      "fiGi": "sample string 18",
      "hooverCode": "sample string 19",
      "webSite": "sample string 20",
      "isMarkitAuthorized": false,
      "requiresSubscription": false,
      "requestID": 23
    }
  ],
  "errorOccurred": false,
  "errorMessages": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "request": {
    "query": "sample string 1",
    "maxResults": 2,
    "mappingType": 0,
    "sdkVersion": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<EntityMappingResponse 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>
    <MappingType>All</MappingType>
    <MaxResults>2</MaxResults>
    <Query>sample string 1</Query>
  </Request>
  <Entities xmlns:d2p1="http://schemas.datacontract.org/2004/07/MA.CreditEdge.DataObjects">
    <d2p1:EntityIdentifiers>
      <d2p1:BloombergId>15</d2p1:BloombergId>
      <d2p1:CountryCode>sample string 8</d2p1:CountryCode>
      <d2p1:Cusip>sample string 6</d2p1:Cusip>
      <d2p1:EntityType>All</d2p1:EntityType>
      <d2p1:Exchange>sample string 5</d2p1:Exchange>
      <d2p1:FiGi>sample string 18</d2p1:FiGi>
      <d2p1:HooverCode>sample string 19</d2p1:HooverCode>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:IndustryCode>sample string 10</d2p1:IndustryCode>
      <d2p1:IsMarkitAuthorized>false</d2p1:IsMarkitAuthorized>
      <d2p1:Isin>sample string 7</d2p1:Isin>
      <d2p1:LEI>sample string 17</d2p1:LEI>
      <d2p1:MoodysOrgId>sample string 14</d2p1:MoodysOrgId>
      <d2p1:NaicsCode>sample string 13</d2p1:NaicsCode>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:OrganizationType>Public</d2p1:OrganizationType>
      <d2p1:ParentId>sample string 2</d2p1:ParentId>
      <d2p1:RegionCode>sample string 9</d2p1:RegionCode>
      <d2p1:RequestID>23</d2p1:RequestID>
      <d2p1:RequiresSubscription>false</d2p1:RequiresSubscription>
      <d2p1:SectorCode>sample string 11</d2p1:SectorCode>
      <d2p1:Sedol>sample string 16</d2p1:Sedol>
      <d2p1:SicCode>sample string 12</d2p1:SicCode>
      <d2p1:Ticker>sample string 4</d2p1:Ticker>
      <d2p1:WebSite>sample string 20</d2p1:WebSite>
    </d2p1:EntityIdentifiers>
    <d2p1:EntityIdentifiers>
      <d2p1:BloombergId>15</d2p1:BloombergId>
      <d2p1:CountryCode>sample string 8</d2p1:CountryCode>
      <d2p1:Cusip>sample string 6</d2p1:Cusip>
      <d2p1:EntityType>All</d2p1:EntityType>
      <d2p1:Exchange>sample string 5</d2p1:Exchange>
      <d2p1:FiGi>sample string 18</d2p1:FiGi>
      <d2p1:HooverCode>sample string 19</d2p1:HooverCode>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:IndustryCode>sample string 10</d2p1:IndustryCode>
      <d2p1:IsMarkitAuthorized>false</d2p1:IsMarkitAuthorized>
      <d2p1:Isin>sample string 7</d2p1:Isin>
      <d2p1:LEI>sample string 17</d2p1:LEI>
      <d2p1:MoodysOrgId>sample string 14</d2p1:MoodysOrgId>
      <d2p1:NaicsCode>sample string 13</d2p1:NaicsCode>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:OrganizationType>Public</d2p1:OrganizationType>
      <d2p1:ParentId>sample string 2</d2p1:ParentId>
      <d2p1:RegionCode>sample string 9</d2p1:RegionCode>
      <d2p1:RequestID>23</d2p1:RequestID>
      <d2p1:RequiresSubscription>false</d2p1:RequiresSubscription>
      <d2p1:SectorCode>sample string 11</d2p1:SectorCode>
      <d2p1:Sedol>sample string 16</d2p1:Sedol>
      <d2p1:SicCode>sample string 12</d2p1:SicCode>
      <d2p1:Ticker>sample string 4</d2p1:Ticker>
      <d2p1:WebSite>sample string 20</d2p1:WebSite>
    </d2p1:EntityIdentifiers>
    <d2p1:EntityIdentifiers>
      <d2p1:BloombergId>15</d2p1:BloombergId>
      <d2p1:CountryCode>sample string 8</d2p1:CountryCode>
      <d2p1:Cusip>sample string 6</d2p1:Cusip>
      <d2p1:EntityType>All</d2p1:EntityType>
      <d2p1:Exchange>sample string 5</d2p1:Exchange>
      <d2p1:FiGi>sample string 18</d2p1:FiGi>
      <d2p1:HooverCode>sample string 19</d2p1:HooverCode>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:IndustryCode>sample string 10</d2p1:IndustryCode>
      <d2p1:IsMarkitAuthorized>false</d2p1:IsMarkitAuthorized>
      <d2p1:Isin>sample string 7</d2p1:Isin>
      <d2p1:LEI>sample string 17</d2p1:LEI>
      <d2p1:MoodysOrgId>sample string 14</d2p1:MoodysOrgId>
      <d2p1:NaicsCode>sample string 13</d2p1:NaicsCode>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:OrganizationType>Public</d2p1:OrganizationType>
      <d2p1:ParentId>sample string 2</d2p1:ParentId>
      <d2p1:RegionCode>sample string 9</d2p1:RegionCode>
      <d2p1:RequestID>23</d2p1:RequestID>
      <d2p1:RequiresSubscription>false</d2p1:RequiresSubscription>
      <d2p1:SectorCode>sample string 11</d2p1:SectorCode>
      <d2p1:Sedol>sample string 16</d2p1:Sedol>
      <d2p1:SicCode>sample string 12</d2p1:SicCode>
      <d2p1:Ticker>sample string 4</d2p1:Ticker>
      <d2p1:WebSite>sample string 20</d2p1:WebSite>
    </d2p1:EntityIdentifiers>
  </Entities>
</EntityMappingResponse>