/benzinga-reference | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
benzinga_reference_get_consensus_ratings_1 | Returns analyst ratings data] |
benzinga_reference_get_gov_usa_congress_trades | Returns government trades data |
benzinga_reference_get_logos | Logos for market securities |
benzinga_reference_get_logos_search | Search logos for market securities/companies |
benzinga_reference_get_logos_sync | Bulk sync logos. |
benzinga_reference_get_sec_insider_transactions_filings | Returns insider transactions data (SEC Form 4) |
benzinga_reference_get_consensus_ratings_1
Returns analyst ratings data] Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pagesize | integer | No | — | Number of results returned. Limit 1000 |
parameters[date_from] | string | No | — | Date to query from point in time. |
parameters[date_to] | string | No | — | Date to query to point in time. |
parameters[tickers] | string | No | — | One ticker symbol to query the aggregate for. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use “parameters[securities]” instead). Ignored by the Economics endpoint. Maximum 1 ticker. |
simplify | boolean | No | — | To simplify the aggregate ratings to only BUY, SELL, HOLD, default will return all ratings (STRONG_BUY, BUY, HOLD, SELL, STRONG_SELL). |
aggregate_type | string | No | — | To aggregate the ratings by either number or percentage. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pagesize": {
"type": "integer",
"description": "Number of results returned. Limit 1000"
},
"parameters[date_from]": {
"type": "string",
"description": "Date to query from point in time."
},
"parameters[date_to]": {
"type": "string",
"description": "Date to query to point in time."
},
"parameters[tickers]": {
"type": "string",
"description": "One ticker symbol to query the aggregate for. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use \"parameters[securities]\" instead). Ignored by the Economics endpoint. Maximum 1 ticker."
},
"simplify": {
"type": "boolean",
"description": "To simplify the aggregate ratings to only BUY, SELL, HOLD, default will return all ratings (STRONG_BUY, BUY, HOLD, SELL, STRONG_SELL)."
},
"aggregate_type": {
"type": "string",
"description": "To aggregate the ratings by either number or percentage.",
"enum": [
"number",
"percentage"
]
}
},
"required": [
"PCID"
]
}
benzinga_reference_get_gov_usa_congress_trades
Returns government trades data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chamber | string | No | — | Specific chamber of congress, either House or Senate. Defaults to all of congress. |
date | string | No | — | Date to query for data. Shorthand for date_from and date_to if they are the same. Defaults for latest. |
date_from | string | No | — | Date to query from point in time. |
date_to | string | No | — | Date to query to point in time. |
fields | string[] | No | — | A comma (,) separated list of returned fields. |
pagesize | integer | No | — | Number of results returned. Limit 1000 |
page | integer | No | — | Page offset. |
search_keys | string | No | — | One or more security symbols separated by a comma. Maximum 50 securities. Security identifiers must be in the format of ticker symbols, only for US-listed equities. |
updated_since | number | No | — | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. Timestamp may also be in python format to include millisecond updates. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"chamber": {
"type": "string",
"description": "Specific chamber of congress, either House or Senate. Defaults to all of congress."
},
"date": {
"type": "string",
"description": "Date to query for data. Shorthand for date_from and date_to if they are the same. Defaults for latest."
},
"date_from": {
"type": "string",
"description": "Date to query from point in time."
},
"date_to": {
"type": "string",
"description": "Date to query to point in time."
},
"fields": {
"type": "array",
"items": {
"type": "string",
"format": "array"
},
"description": "A comma (,) separated list of returned fields."
},
"pagesize": {
"type": "integer",
"description": "Number of results returned. Limit 1000"
},
"page": {
"type": "integer",
"description": "Page offset."
},
"search_keys": {
"type": "string",
"description": "One or more security symbols separated by a comma. Maximum 50 securities. Security identifiers must be in the format of ticker symbols, only for US-listed equities."
},
"updated_since": {
"type": "number",
"description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. Timestamp may also be in python format to include millisecond updates."
}
},
"required": [
"PCID"
]
}
benzinga_reference_get_logos
Logos for market securities Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
symbols | string | Yes | — | A list of ticker symbols separated by a comma (,). Limit 50 tickers per request. |
filters | string | No | — | A list of client-specific filters to be applied. Filters are separated by a comma (,). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"symbols": {
"type": "string",
"description": "A list of ticker symbols separated by a comma (,). Limit 50 tickers per request."
},
"filters": {
"type": "string",
"description": "A list of client-specific filters to be applied. Filters are separated by a comma (,)."
}
},
"required": [
"PCID",
"symbols"
]
}
benzinga_reference_get_logos_search
Search logos for market securities/companies Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
search_keys | string[] | Yes | — | A comma (,) separated list of search identifiers. Identifiers are based on the search_type field. Limit 100 per request. Example: F,AAPL Logos can also be queried with format <EXCHANGE>:<SYMBOL> i.e. NYSE:ARI |
search_keys_type | string | No | — | The type of identifier being searched. Supported types are currently a security symbol and CIK. |
fields | string[] | Yes | — | A comma (,) separated list of returned fields. Example: mark_light,background_light Would return ONLY the mark_light, background_light values from the API. |
composite_auto | boolean | No | — | If no image exists, generate a fill image based on the company name and background color. |
composite_radius | integer | No | — | Apply a radius to the composite image. Default value is 0. Maximum value is 50 (50%) which will result in a circle. |
scale | string | No | — | Specified as the WIDTHxHEIGHT to scale the image down in pixels. Images will only be scaled down, never up, and fit within the bounds set. In CSS terms, the object-fit property is set to contain. Scale will be applied to: logo_light, logo_dark, mark_light, mark_dark, mark_composite_light, mark_composite_dark Example: 300x600 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"search_keys": {
"type": "array",
"items": {
"type": "string",
"format": "array"
},
"description": "A comma (,) separated list of search identifiers. Identifiers are based on the `search_type` field. Limit 100 per request. Example: F,AAPL Logos can also be queried with format <EXCHANGE>:<SYMBOL> i.e. NYSE:ARI"
},
"search_keys_type": {
"type": "string",
"description": "The type of identifier being searched. Supported types are currently a security symbol and CIK.",
"enum": [
"symbol",
"cik",
"cusip",
"isin"
]
},
"fields": {
"type": "array",
"items": {
"type": "string",
"format": "array",
"enum": [
"logo_light",
"logo_dark",
"logo_vector_light",
"logo_vector_dark",
"mark_light",
"mark_dark",
"mark_vector_light",
"mark_vector_dark",
"mark_composite_light",
"mark_composite_dark"
]
},
"description": "A comma (,) separated list of returned fields. Example: mark_light,background_light Would return ONLY the mark_light, background_light values from the API."
},
"composite_auto": {
"type": "boolean",
"description": "If no image exists, generate a fill image based on the company name and background color."
},
"composite_radius": {
"type": "integer",
"description": "Apply a radius to the composite image. Default value is 0. Maximum value is 50 (50%) which will result in a circle."
},
"scale": {
"type": "string",
"description": "Specified as the WIDTHxHEIGHT to scale the image down in pixels. Images will only be scaled down, never up, and fit within the bounds set. In CSS terms, the object-fit property is set to `contain`. Scale will be applied to: logo_light, logo_dark, mark_light, mark_dark, mark_composite_light, mark_composite_dark Example: 300x600"
}
},
"required": [
"PCID",
"search_keys",
"fields"
]
}
benzinga_reference_get_logos_sync
Bulk sync logos. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
updated_since | integer | No | — | Last updated unix timestamp, UTC |
fields | string[] | Yes | — | A comma (,) separated list of returned fields. Example: mark_light,background_light Would return ONLY the mark_light, background_light values from the API. |
composite_auto | boolean | No | — | If no image exists, generate a fill image based on the company name and background color. |
composite_radius | integer | No | — | Apply a radius to the composite image. Default value is 0. Maximum value is 50 (50%) which will result in a circle. |
scale | string | No | — | Specified as the WIDTHxHEIGHT to scale the image down in pixels. Images will only be scaled down, never up, and fit within the bounds set. In CSS terms, the object-fit property is set to contain. Scale will be applied to: logo_light, logo_dark, mark_light, mark_dark, mark_composite_light, mark_composite_dark Example: 300x600 |
page | integer | No | — | Page offset. |
pagesize | integer | No | — | Number of results returned. Default 100 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"updated_since": {
"type": "integer",
"description": "Last updated unix timestamp, UTC"
},
"fields": {
"type": "array",
"items": {
"type": "string",
"format": "array",
"enum": [
"logo_light",
"logo_dark",
"logo_vector_light",
"logo_vector_dark",
"mark_light",
"mark_dark",
"mark_vector_light",
"mark_vector_dark",
"mark_composite_light",
"mark_composite_dark"
]
},
"description": "A comma (,) separated list of returned fields. Example: mark_light,background_light Would return ONLY the mark_light, background_light values from the API."
},
"composite_auto": {
"type": "boolean",
"description": "If no image exists, generate a fill image based on the company name and background color."
},
"composite_radius": {
"type": "integer",
"description": "Apply a radius to the composite image. Default value is 0. Maximum value is 50 (50%) which will result in a circle."
},
"scale": {
"type": "string",
"description": "Specified as the WIDTHxHEIGHT to scale the image down in pixels. Images will only be scaled down, never up, and fit within the bounds set. In CSS terms, the object-fit property is set to `contain`. Scale will be applied to: logo_light, logo_dark, mark_light, mark_dark, mark_composite_light, mark_composite_dark Example: 300x600"
},
"page": {
"type": "integer",
"description": "Page offset."
},
"pagesize": {
"type": "integer",
"description": "Number of results returned. Default 100"
}
},
"required": [
"PCID",
"fields"
]
}
benzinga_reference_get_sec_insider_transactions_filings
Returns insider transactions data (SEC Form 4) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
date | string | No | — | Date to query for data. Shorthand for date_from and date_to if they are the same. Defaults for latest. |
date_from | string | No | — | Date to query from point in time. |
date_to | string | No | — | Date to query to point in time. |
fields | string[] | No | — | A comma (,) separated list of returned fields. |
pagesize | integer | No | — | Number of results returned. Limit 1000 |
page | integer | No | — | Page offset. |
search_keys | string | No | — | One or more security symbols separated by a comma. Maximum 50 securities. Security identifiers must be in the format of ticker symbols, only for US-listed equities. |
search_keys_type | string | No | — | The type of identifier being searched. Supported types are currently a security symbol, accession number and filing id. |
updated_since | number | No | — | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. Timestamp may also be in python format to include millisecond updates. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"date": {
"type": "string",
"description": "Date to query for data. Shorthand for date_from and date_to if they are the same. Defaults for latest."
},
"date_from": {
"type": "string",
"description": "Date to query from point in time."
},
"date_to": {
"type": "string",
"description": "Date to query to point in time."
},
"fields": {
"type": "array",
"items": {
"type": "string",
"format": "array"
},
"description": "A comma (,) separated list of returned fields."
},
"pagesize": {
"type": "integer",
"description": "Number of results returned. Limit 1000"
},
"page": {
"type": "integer",
"description": "Page offset."
},
"search_keys": {
"type": "string",
"description": "One or more security symbols separated by a comma. Maximum 50 securities. Security identifiers must be in the format of ticker symbols, only for US-listed equities."
},
"search_keys_type": {
"type": "string",
"description": "The type of identifier being searched. Supported types are currently a security symbol, accession number and filing id.",
"enum": [
"symbol",
"accession_number",
"id"
]
},
"updated_since": {
"type": "number",
"description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. Timestamp may also be in python format to include millisecond updates."
}
},
"required": [
"PCID"
]
}