Entities Reference¶

In Bigdata we differentiate between these entity types:

Company
Product
ProductType
Organization
OrganizationType
Person
Place
Facility
Landmark
Concept
Etf

pydantic model Company[source]¶

Represents an entity in RavenPack’s dataset.

Show JSON schema

{
   "title": "Company",
   "description": "Represents an entity in RavenPack's dataset.",
   "type": "object",
   "properties": {
      "key": {
         "title": "Key",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "volume": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Volume"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "entityType": {
         "const": "COMP",
         "default": "COMP",
         "title": "Entitytype",
         "type": "string"
      },
      "group1": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group1"
      },
      "group2": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group2"
      },
      "group3": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group3"
      },
      "group4": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group4"
      },
      "group5": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group5"
      },
      "metadata1": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Metadata1"
      },
      "metadata5": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Metadata5"
      },
      "metadata7": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Metadata7"
      },
      "metadata8": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Metadata8"
      },
      "metadata9": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Metadata9"
      },
      "metadata10": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Metadata10"
      }
   },
   "required": [
      "key",
      "name"
   ]
}

Fields:

company_type (str | None)
country (str | None)
cusip_values (list[str] | None)
description (str | None)
entity_type (Literal['COMP'])
id (str)
industry (str | None)
industry_group (str | None)
isin_values (list[str] | None)
listing_values (list[str] | None)
name (str)
sector (str | None)
sedol_values (list[str] | None)
ticker (str | None)
volume (int | None)
webpage (str | None)

field company_type: str | None = None¶

field country: str | None = None¶

field cusip_values: list[str] | None = None¶

field description: str | None = None¶

field entity_type: Literal['COMP'] = 'COMP'¶

field id: str [Required]¶

field industry: str | None = None¶

field industry_group: str | None = None¶

field isin_values: list[str] | None = None¶

field listing_values: list[str] | None = None¶

field name: str [Required]¶

field sector: str | None = None¶

field sedol_values: list[str] | None = None¶

field ticker: str | None = None¶

field volume: int | None = None¶

field webpage: str | None = None¶

pydantic model Concept[source]¶

Basically everything else

Show JSON schema

{
   "title": "Concept",
   "description": "Basically everything else",
   "type": "object",
   "properties": {
      "key": {
         "title": "Key",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "volume": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Volume"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "entityType": {
         "title": "Entitytype",
         "type": "string"
      },
      "group1": {
         "title": "Group1",
         "type": "string"
      },
      "group2": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group2"
      },
      "group3": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group3"
      },
      "group4": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group4"
      },
      "group5": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group5"
      }
   },
   "required": [
      "key",
      "name",
      "entityType",
      "group1"
   ]
}

Fields:

concept_level_2 (str | None)
concept_level_3 (str | None)
concept_level_4 (str | None)
concept_level_5 (str | None)
description (str | None)
entity_type (str)
entity_type_name (str)
id (str)
name (str)
volume (int | None)

field concept_level_2: str | None = None¶

field concept_level_3: str | None = None¶

field concept_level_4: str | None = None¶

field concept_level_5: str | None = None¶

field description: str | None = None¶

field entity_type: str [Required]¶

field entity_type_name: str [Required]¶

field id: str [Required]¶

field name: str [Required]¶

field volume: int | None = None¶

pydantic model Etf[source]¶

Represents an entity in RavenPack’s dataset.

Show JSON schema

{
   "title": "Etf",
   "description": "Represents an entity in RavenPack's dataset.",
   "type": "object",
   "properties": {
      "key": {
         "title": "Key",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "volume": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Volume"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "category": {
         "const": "ETFs",
         "default": "ETFs",
         "title": "Category",
         "type": "string"
      },
      "entityType": {
         "const": "COMP",
         "default": "COMP",
         "title": "Entitytype",
         "type": "string"
      },
      "group1": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group1"
      },
      "group2": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group2"
      },
      "group3": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group3"
      },
      "group4": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group4"
      },
      "group5": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group5"
      },
      "metadata1": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Metadata1"
      },
      "metadata5": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Metadata5"
      },
      "metadata7": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Metadata7"
      },
      "metadata8": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Metadata8"
      },
      "metadata9": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Metadata9"
      },
      "metadata10": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Metadata10"
      }
   },
   "required": [
      "key",
      "name"
   ]
}

Fields:

category (Literal['ETFs'])
company_type (str | None)
country (str | None)
cusip_values (list[str] | None)
description (str | None)
entity_type (Literal['COMP'])
id (str)
industry (str | None)
industry_group (str | None)
isin_values (list[str] | None)
listing_values (list[str] | None)
name (str)
sector (str | None)
sedol_values (list[str] | None)
ticker (str | None)
volume (int | None)
webpage (str | None)

field category: Literal['ETFs'] = 'ETFs'¶

field company_type: str | None = None¶

field country: str | None = None¶

field cusip_values: list[str] | None = None¶

field description: str | None = None¶

field entity_type: Literal['COMP'] = 'COMP'¶

field id: str [Required]¶

field industry: str | None = None¶

field industry_group: str | None = None¶

field isin_values: list[str] | None = None¶

field listing_values: list[str] | None = None¶

field name: str [Required]¶

field sector: str | None = None¶

field sedol_values: list[str] | None = None¶

field ticker: str | None = None¶

field volume: int | None = None¶

field webpage: str | None = None¶

pydantic model Facility[source]¶

A facility. E.g. a factory, a mine, etc.

Show JSON schema

{
   "title": "Facility",
   "description": "A facility. E.g. a factory, a mine, etc.",
   "type": "object",
   "properties": {
      "key": {
         "title": "Key",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "volume": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Volume"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "entityType": {
         "const": "FCTY",
         "default": "FCTY",
         "title": "Entitytype",
         "type": "string"
      },
      "group4": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group4"
      },
      "group5": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group5"
      }
   },
   "required": [
      "key",
      "name"
   ]
}

Fields:

country (str | None)
description (str | None)
entity_type (Literal['FCTY'])
id (str)
name (str)
region (str | None)
volume (int | None)

field country: str | None = None¶

field description: str | None = None¶

field entity_type: Literal['FCTY'] = 'FCTY'¶

field id: str [Required]¶

field name: str [Required]¶

field region: str | None = None¶

field volume: int | None = None¶

pydantic model Landmark[source]¶

A landmark. E.g. a mountain, a lake, etc.

Show JSON schema

{
   "title": "Landmark",
   "description": "A landmark. E.g. a mountain, a lake, etc.",
   "type": "object",
   "properties": {
      "key": {
         "title": "Key",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "volume": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Volume"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "entityType": {
         "const": "LAND",
         "default": "LAND",
         "title": "Entitytype",
         "type": "string"
      },
      "group2": {
         "title": "Group2",
         "type": "string"
      },
      "group4": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group4"
      },
      "group5": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group5"
      }
   },
   "required": [
      "key",
      "name",
      "group2"
   ]
}

Fields:

country (str | None)
description (str | None)
entity_type (Literal['LAND'])
id (str)
landmark_type (str)
name (str)
region (str | None)
volume (int | None)

field country: str | None = None¶

field description: str | None = None¶

field entity_type: Literal['LAND'] = 'LAND'¶

field id: str [Required]¶

field landmark_type: str [Required]¶

field name: str [Required]¶

field region: str | None = None¶

field volume: int | None = None¶

pydantic model Organization[source]¶

Show JSON schema

{
   "title": "Organization",
   "type": "object",
   "properties": {
      "key": {
         "title": "Key",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "volume": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Volume"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "entityType": {
         "const": "ORGA",
         "default": "ORGA",
         "title": "Entitytype",
         "type": "string"
      },
      "group1": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group1"
      },
      "group2": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group2"
      }
   },
   "required": [
      "key",
      "name"
   ]
}

Fields:

country (str | None)
description (str | None)
entity_type (Literal['ORGA'])
id (str)
name (str)
organization_type (str | None)
volume (int | None)

field country: str | None = None¶

field description: str | None = None¶

field entity_type: Literal['ORGA'] = 'ORGA'¶

field id: str [Required]¶

field name: str [Required]¶

field organization_type: str | None = None¶

field volume: int | None = None¶

pydantic model OrganizationType[source]¶

Show JSON schema

{
   "title": "OrganizationType",
   "type": "object",
   "properties": {
      "key": {
         "title": "Key",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "volume": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Volume"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "entityType": {
         "const": "ORGT",
         "default": "ORGT",
         "title": "Entitytype",
         "type": "string"
      }
   },
   "required": [
      "key",
      "name"
   ]
}

Fields:

description (str | None)
entity_type (Literal['ORGT'])
id (str)
name (str)
volume (int | None)

field description: str | None = None¶

field entity_type: Literal['ORGT'] = 'ORGT'¶

field id: str [Required]¶

field name: str [Required]¶

field volume: int | None = None¶

pydantic model Person[source]¶

A person

Show JSON schema

{
   "title": "Person",
   "description": "A person",
   "type": "object",
   "properties": {
      "key": {
         "title": "Key",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "volume": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Volume"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "entityType": {
         "const": "PEOP",
         "default": "PEOP",
         "title": "Entitytype",
         "type": "string"
      },
      "group1": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group1"
      },
      "group2": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group2"
      },
      "group3": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group3"
      },
      "group4": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group4"
      }
   },
   "required": [
      "key",
      "name"
   ]
}

Fields:

description (str | None)
employer (str | None)
entity_type (Literal['PEOP'])
gender (str | None)
id (str)
name (str)
nationality (str | None)
position (str | None)
volume (int | None)

field description: str | None = None¶

field employer: str | None = None¶

field entity_type: Literal['PEOP'] = 'PEOP'¶

field gender: str | None = None¶

field id: str [Required]¶

field name: str [Required]¶

field nationality: str | None = None¶

field position: str | None = None¶

field volume: int | None = None¶

pydantic model Place[source]¶

A place. E.g. a country, city, etc.

Show JSON schema

{
   "title": "Place",
   "description": "A place. E.g. a country, city, etc.",
   "type": "object",
   "properties": {
      "key": {
         "title": "Key",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "volume": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Volume"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "entityType": {
         "const": "PLCE",
         "default": "PLCE",
         "title": "Entitytype",
         "type": "string"
      },
      "group2": {
         "title": "Group2",
         "type": "string"
      },
      "group4": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group4"
      },
      "group5": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group5"
      }
   },
   "required": [
      "key",
      "name",
      "group2"
   ]
}

Fields:

country (str | None)
description (str | None)
entity_type (Literal['PLCE'])
id (str)
name (str)
place_type (str)
region (str | None)
volume (int | None)

field country: str | None = None¶

field description: str | None = None¶

field entity_type: Literal['PLCE'] = 'PLCE'¶

field id: str [Required]¶

field name: str [Required]¶

field place_type: str [Required]¶

field region: str | None = None¶

field volume: int | None = None¶

pydantic model Product[source]¶

Show JSON schema

{
   "title": "Product",
   "type": "object",
   "properties": {
      "key": {
         "title": "Key",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "volume": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Volume"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "entityType": {
         "const": "PROD",
         "default": "PROD",
         "title": "Entitytype",
         "type": "string"
      },
      "group1": {
         "title": "Group1",
         "type": "string"
      },
      "group2": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group2"
      }
   },
   "required": [
      "key",
      "name",
      "group1"
   ]
}

Fields:

description (str | None)
entity_type (Literal['PROD'])
id (str)
name (str)
product_owner (str | None)
product_type (str)
volume (int | None)

field description: str | None = None¶

field entity_type: Literal['PROD'] = 'PROD'¶

field id: str [Required]¶

field name: str [Required]¶

field product_owner: str | None = None¶

field product_type: str [Required]¶

field volume: int | None = None¶

pydantic model ProductType[source]¶

Show JSON schema

{
   "title": "ProductType",
   "type": "object",
   "properties": {
      "key": {
         "title": "Key",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "volume": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Volume"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Description"
      },
      "entityType": {
         "const": "PRDT",
         "default": "PRDT",
         "title": "Entitytype",
         "type": "string"
      }
   },
   "required": [
      "key",
      "name"
   ]
}

Fields:

description (str | None)
entity_type (Literal['PRDT'])
id (str)
name (str)
volume (int | None)

field description: str | None = None¶

field entity_type: Literal['PRDT'] = 'PRDT'¶

field id: str [Required]¶

field name: str [Required]¶

field volume: int | None = None¶

pydantic model QueryComponentMixin[source]¶

For making queries

Show JSON schema

{
   "title": "QueryComponentMixin",
   "description": "For making queries",
   "type": "object",
   "properties": {}
}

make_copy()[source]¶

Return type:: QueryComponent

to_expression()[source]¶

Return type:: Expression