RP_APIMappingRequest: RP_APIMappingRequest

View source: R/RP_SelfServiceAPI_EndPoints.R

RP_APIMappingRequestR Documentation

RP_APIMappingRequest

Description

The entity-mapping endpoint may be used to map from a universe of entity or security identifiers into RavenPack’s entity universe. One may pass in identifiers such as entity names, listings, ISIN values, CUSIP values, etc. and the endpoint will return the corresponding RP_ENTITY_ID for the possible matches. In the event that the entity mapping API is unable to match the requested entity to an entity in the RavenPack entity universe, there will be no mapped entities and the requested data is returned as an error. In the event that multiple entities are matched, the entities will be returned ranked with a relative score, which may be used to automatically filter or sort for further analysis.

Usage

RP_APIMappingRequest(APIHandler, payload)

Arguments

APIHandler

An API handler, created using RP_CreateAPIHandler

payload

A string in JSON format with the request body parameters.

Value

A list with the mapping information, upon success. Error information otherwise.

Author(s)

Jose A. Guerrero-Colon


RavenPack/r-api documentation built on July 30, 2022, 9:56 p.m.