For a deeper look into our DataScope Select REST API, look into:

Overview |  Quickstart |  Documentation |  Downloads |  Tutorials

question

Upvotes
Accepted
peter.vonbredow0 avatar image
5 ●1 ●2 ●5

DSS Rest call for Corporate Actions with filter

I am using the Extractions/ExtractWithNotes endpoint to get corporate actions for a list of instruments and a set timeframe.

I believe there is a feature in the API to use filters.

What is the syntax to add a filter to the ExtractionRequest? For example, if I only want to retrieve records where "Capital Change Event Type" = 21 or 80

(N.b. 21 is the ID for a stock split; 80 is a stock dividend, same stock)

Thanks very much

dss-rest-apicorporate-actionsfilter
icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

1 Answer

· Write an Answer
Upvotes
Accepted
Jirapongse avatar image
78.9k ●250 ●52 ●74

@peter.vonbredow0

You can refer to the REST API Reference Tree for the list of available parameters of extraction requests.

For example, the CorporateActionsStandardExtractionRequest has the following parameters.

1652858983598.png

You can set the values and select JSON Model to see the request message in JSON format.

I couldn't see a parameter that can be used to filter the data by the Event Type. However, you can contact the DataScope support team directly via MyRefinitiv to confirm it.




1652858983598.png (48.9 KiB)
icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

peter.vonbredow0 avatar image peter.vonbredow0

K. Jirapongse,

Thanks for the quick response. In the screenshot you shared, I can see 'JSON Model', however when I look at the Rest API Reference Tree

https://selectapi.datascope.refinitiv.com/RestApi.Help/Context/Entity?ctx=Extractions&ent=CorporateActionsStandardReportTemplate&grp=Report%20Template

I can't see any reference to 'JSON Model', even when I search the page.

What page are you looking at?

Jirapongse avatar image Jirapongse peter.vonbredow0

@peter.vonbredow0

Please select Extractions -> On Demand Extraction -> ExtractionWithNotes.

1652863823323.png

Then, select the ExtractionRequest.

1652863882764.png


1652863823323.png (21.2 KiB)
1652863882764.png (79.4 KiB)

Write an Answer

Hint: Notify or tag a user in this post by typing @username.

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.