Reference.corporate_actions.list_enums

Requests documentation for the full set of enumerations used across corporate actions data, like event actions and statuses.

Returns

dict[str, list[dict]]

The raw JSON response as a dict keyed by enum group name (e.g. ACTION). Each value is a list of variants:

Field
Type
Description
code
str or None
Code for the enum variant.
description
str
Description of the enum variant.
See also

Reference data enums for a lookup table of possible enumeration field values.

API method 
1
Reference.corporate_actions.list_enums() -> dict[str, list[dict]]
Example usage 
1
2
3
4
5
6
7
import databento as db

client = db.Reference("$YOUR_API_KEY")

enum_docs = client.corporate_actions.list_enums()

print(enum_docs["ACTION"])
Example response 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
[
    {
        "code": "C",
        "description": "Cancelled"
    },
    {
        "code": "D",
        "description": "Deleted"
    },
    {
        "code": "I",
        "description": "Inserted"
    },
    {
        "code": "P",
        "description": "Payment details Cancelled by Issuer"
    },
    {
        "code": "Q",
        "description": "Payment details Deleted by Data Supplier"
    },
    {
        "code": "U",
        "description": "Updated"
    }
]