Response Members
The response for each of the following endpoints contains the same member-structure.
| Member | Description |
|---|---|
| name | Either an IFI name or variation |
| country | Country of name |
| address | (optional) Address of name |
| ticker | (optional) Ticker structure represents the ticker symbol and market identifier code (MIC) the symbol is traded on. |
| name_type | Values include: N=IFI name |
| parent_relationship | Values include: O=owner |
| category | Values include: Public |
| updated | The last time the Name or Ownership hierarchy was reviewed by the editorial team |
| extract_status | Status. Values include: R=reviewed |
/names/name
This endpoint returns a list of the top 25 names structures ranked by name_type and parent_relationship in the following order:
name_typeNparent_relationshipO, S, F, and then Mname_typeV
It is important to use this endpoint prior to using the other names services to ensure that you are using the correct IFI standardized name format. Note that the results of this endpoint have no inherent relationship to each other.
| Method | GET | ||
|---|---|---|---|
| Path | /names/name | ||
| Parameter | Values | Description | |
| @q | Search expression, e.g., waze* | Any standard un-fielded Solr search expression | |
Example
wget -O- -q \ --header 'x-user:x' \ --header 'x-password:y' \ 'https://cdws21.ificlaims.com/names/name?q=Eberhard'
Response
{
"time" : "0.100",
"status" : "success",
"content" : {
"names" : [
{
"country" : "DE",
"extract_status" : "V",
"name" : "Eberhard Karls Universitaet Tuebingen",
"parent_relationship" : "O",
"category" : "Academic",
"updated" : "2020-08-12T00:00:00Z",
"name_type" : "N"
},
{
"country" : "DE",
"extract_status" : "V",
"name" : "Eberhard Hoesch and Soehne GmbH",
"parent_relationship" : "S",
"name_type" : "N"
},
; etc ...
{
"country" : "DE",
"extract_status" : "V",
"name" : "Eberhard Hoesch and Soehne GmbH Giesserei und Maschinenfabrik",
"name_type" : "N"
},
{
"country" : "DE",
"extract_status" : "V",
"name" : "Eberhard Hoesch and Soehne GmbH Verfahrens und Anlagentechnik",
"name_type" : "N"
},
{
"name" : "EBERHARD FABER",
"updated" : "1976-12-31T00:00:00Z",
"name_type" : "V"
},
{
"name" : "DR. EBERHARD MOLL GMBH",
"name_type" : "V"
},
],
"numFound" : 308,
"QTime" : 87
}
}
/names/ticker
This endpoint returns the name associated with a valid ticker symbol.
| Method | GET | ||
|---|---|---|---|
| Path | /names/ticker | ||
| Parameter | Values | Description | |
| @q | Search expression, e.g., PFE | A valid ticker symbol | |
Example
wget -O- -q \ --header 'x-user:x' \ --header 'x-password:y' \ 'https://cdws21.ificlaims.com/names/ticker?q=PFE'
Response
{
"time" : "0.275",
"status" : "success",
"content" : {
"names" : [
{
"country" : "US",
"name" : "Pfizer Inc",
"parent_relationship" : "O",
"ticker" : [
{
"symbol" : "PFE",
"exchange" : "XNYS"
}
],
"name_type" : "N",
"extract_status" : "V",
"updated" : "2018-05-08T00:00:00Z",
"address" : "235 East 42nd Street, New York, NY, 10017, US",
"category" : "Public"
}
],
"numFound" : 1,
"QTime" : 233
}
}
/names/ultimate
This endpoint returns the ultimate corporate parent for a given subsidiary.
| Method | GET | ||
|---|---|---|---|
| Path | /names/ultimate | ||
| Parameter | Values | Description | |
| @q | String, e.g., Waze Inc | Any IFI company name with name_type = N and parent_relationship = (S, F or M) | |
Example
wget -O- -q \ --header 'x-user:x' \ --header 'x-password:y' \ 'https://cdws21.ificlaims.com/names/ultimate?q=Waze Inc'
Response
{
"time" : "0.789",
"status" : "success",
"content" : {
"ultimate" : {
"country" : "US",
"name" : "Alphabet Inc",
"parent_relationship" : "O",
"ticker" : [
{
"symbol" : "GOOGL",
"exchange" : "XNAS"
}
],
"name_type" : "N",
"extract_status" : "V",
"updated" : "2019-10-17T00:00:00Z",
"address" : "1600 Amphitheatre Parkway, Mountain View, CA, 94043, US"
}
}
}
/names/subsidiaries
This endpoint returns a list of subsidiaries for a given ultimate owner.
| Method | GET | ||
|---|---|---|---|
| Path | /names/subsidiaries | ||
| Parameter | Values | Description | |
| @q | String, e.g., Alphabet Inc | Any IFI company name with name_type = N and parent_relationship = O | |
Example
wget -O- -q \ --header 'x-user:x' \ --header 'x-password:y' \ 'https://cdws21.ificlaims.com/names/subsidiaries?q=Alphabet Inc'
Response (abbreviated)
{
"time" : "0.488",
"status" : "success",
"content" : {
"count" : 129,
"name" : "Alphabet Inc",
"subsidiaries" : [
{
"country" : "US",
"name" : "AdMob Inc",
"extract_status" : "V",
"parent_relationship" : "S",
"name_type" : "N"
},
{
"country" : "US",
"name" : "Adometry Inc",
"extract_status" : "V",
"parent_relationship" : "S",
"name_type" : "N"
},
; etc...
{
"country" : "US",
"name" : "Waze Inc",
"extract_status" : "V",
"parent_relationship" : "S",
"name_type" : "N"
},
{
"country" : "US",
"name" : "Widevine Technologies Inc",
"extract_status" : "V",
"parent_relationship" : "S",
"name_type" : "N"
},
{
"country" : "US",
"name" : "Wildfire Interactive Inc",
"extract_status" : "V",
"parent_relationship" : "S",
"name_type" : "N"
},
; etc...
]
}
}