Skip to content

Commit 934d048

Browse files
author
GitLab CI
committed
Transferred BzGo OpenAPI specs from GitLab to GitHub
1 parent 4f65bc6 commit 934d048

7 files changed

Lines changed: 148 additions & 82 deletions

openapi/analyst-reports-raw-text-api_api.spec.yml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,21 @@ info:
88
paths:
99
/analyst/reports/raw-text:
1010
get:
11-
description: Retrieves raw text content from professional analyst research reports. Returns full-text analyst reports, research notes, and investment recommendations from financial institutions. Includes report metadata, rating changes, price targets, and detailed analysis. Essential for accessing institutional research and analyst sentiment.
11+
description: Retrieves raw text content from professional analyst research
12+
reports. Returns full-text analyst reports, research notes, and
13+
investment recommendations from financial institutions. Includes report
14+
metadata, rating changes, price targets, and detailed analysis.
15+
Essential for accessing institutional research and analyst sentiment.
1216
operationId: get-analyst-reports-raw-text-data
1317
parameters:
14-
- description: "Page number for pagination. Zero-indexed (0 = first page, 1 = second page, etc.). Default: 0"
18+
- description: "Page number for pagination. Zero-indexed (0 = first page, 1 =
19+
second page, etc.). Default: 0"
1520
in: query
1621
name: page
1722
schema:
1823
type: integer
19-
- description: "Number of results per page. Default: 100. Maximum: 100. Returns most recent reports first."
24+
- description: "Number of results per page. Default: 100. Maximum: 100. Returns
25+
most recent reports first."
2026
in: query
2127
name: pagesize
2228
schema:
@@ -80,6 +86,3 @@ components:
8086
example: AAPL
8187
type: string
8288
type: object
83-
servers:
84-
- url: https://api.benzinga.com
85-
description: PROD

openapi/data-api-proxy_api.spec.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1510,6 +1510,3 @@ components:
15101510
symbol:
15111511
type: string
15121512
type: object
1513-
servers:
1514-
- url: https://api.benzinga.com
1515-
description: PROD

openapi/earnings-call-transcripts-api_api.spec.yml

Lines changed: 35 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
11
openapi: 3.0.0
22
info:
33
contact: {}
4-
description: This REST API provides endpoints to search for earnings call transcripts and get earnings call transcript details.
4+
description: This REST API provides endpoints to search for earnings call
5+
transcripts and get earnings call transcript details.
56
termsOfService: http://swagger.io/terms/
67
title: Earnings Call Transcripts API
78
version: 1.0.0
89
paths:
910
/api/v1/earnings-call-transcripts:
1011
get:
11-
description: Retrieves earnings call transcripts for specified companies or call IDs. Returns full text transcripts of quarterly and annual earnings calls including Q&A sessions, speaker identification, and timestamps. Use date filters to retrieve transcripts from specific reporting periods or filter by ticker symbols for company-specific earnings discussions.
12+
description: Retrieves earnings call transcripts for specified companies or call
13+
IDs. Returns full text transcripts of quarterly and annual earnings
14+
calls including Q&A sessions, speaker identification, and timestamps.
15+
Use date filters to retrieve transcripts from specific reporting periods
16+
or filter by ticker symbols for company-specific earnings discussions.
1217
operationId: get-earnings-call-transcripts
1318
parameters:
14-
- description: Comma-separated list of stock ticker symbols to filter earnings call transcripts (e.g., AAPL,MSFT,GOOGL). Returns all transcripts for these companies.
19+
- description: Comma-separated list of stock ticker symbols to filter earnings
20+
call transcripts (e.g., AAPL,MSFT,GOOGL). Returns all transcripts
21+
for these companies.
1522
in: query
1623
name: tickers
1724
style: form
@@ -20,7 +27,9 @@ paths:
2027
type: array
2128
items:
2229
type: string
23-
- description: Comma-separated list of specific call IDs to retrieve. Use this to fetch transcripts for known earnings call identifiers. Takes precedence over ticker filtering.
30+
- description: Comma-separated list of specific call IDs to retrieve. Use this to
31+
fetch transcripts for known earnings call identifiers. Takes
32+
precedence over ticker filtering.
2433
in: query
2534
name: call_id
2635
style: form
@@ -29,29 +38,34 @@ paths:
2938
type: array
3039
items:
3140
type: string
32-
- description: "Page number for pagination. Zero-indexed (0 = first page, 1 = second page, etc.). Default: 0"
41+
- description: "Page number for pagination. Zero-indexed (0 = first page, 1 =
42+
second page, etc.). Default: 0"
3343
in: query
3444
name: page
3545
schema:
3646
type: integer
37-
- description: "Number of results per page. Default: 5. Maximum: 1000. Use larger page sizes for bulk data retrieval."
47+
- description: "Number of results per page. Default: 5. Maximum: 1000. Use larger
48+
page sizes for bulk data retrieval."
3849
in: query
3950
name: pagesize
4051
schema:
4152
type: integer
42-
- description: Start date filter in YYYY-MM-DD format (e.g., 2024-01-01). Returns transcripts from earnings calls on or after this date.
53+
- description: Start date filter in YYYY-MM-DD format (e.g., 2024-01-01). Returns
54+
transcripts from earnings calls on or after this date.
4355
in: query
4456
name: date_from
4557
schema:
4658
type: string
47-
- description: End date filter in YYYY-MM-DD format (e.g., 2024-12-31). Returns transcripts from earnings calls on or before this date.
59+
- description: End date filter in YYYY-MM-DD format (e.g., 2024-12-31). Returns
60+
transcripts from earnings calls on or before this date.
4861
in: query
4962
name: date_to
5063
schema:
5164
type: string
5265
responses:
5366
"200":
54-
description: Array of earnings call transcript summaries with full text and metadata
67+
description: Array of earnings call transcript summaries with full text and
68+
metadata
5569
content:
5670
application/json:
5771
schema:
@@ -81,10 +95,16 @@ paths:
8195
- Earnings Call Transcripts
8296
/api/v1/earnings-call-transcripts/audio:
8397
get:
84-
description: Retrieves downloadable audio file URLs for earnings call recordings. Returns signed URLs for accessing full audio recordings of quarterly and annual earnings calls. Audio files include complete earnings presentations and Q&A sessions. URLs are time-limited and securely signed for authorized access.
98+
description: Retrieves downloadable audio file URLs for earnings call
99+
recordings. Returns signed URLs for accessing full audio recordings of
100+
quarterly and annual earnings calls. Audio files include complete
101+
earnings presentations and Q&A sessions. URLs are time-limited and
102+
securely signed for authorized access.
85103
operationId: get-earnings-call-transcript-audio-files
86104
parameters:
87-
- description: Comma-separated list of stock ticker symbols to filter audio files (e.g., AAPL,MSFT,GOOGL). Returns audio files for all earnings calls from these companies.
105+
- description: Comma-separated list of stock ticker symbols to filter audio files
106+
(e.g., AAPL,MSFT,GOOGL). Returns audio files for all earnings calls
107+
from these companies.
88108
in: query
89109
name: tickers
90110
style: form
@@ -93,7 +113,8 @@ paths:
93113
type: array
94114
items:
95115
type: string
96-
- description: Comma-separated list of specific call IDs to retrieve audio files for. Use this to fetch audio for known earnings call identifiers.
116+
- description: Comma-separated list of specific call IDs to retrieve audio files
117+
for. Use this to fetch audio for known earnings call identifiers.
97118
in: query
98119
name: call_id
99120
style: form
@@ -102,7 +123,8 @@ paths:
102123
type: array
103124
items:
104125
type: string
105-
- description: "Page number for pagination. Zero-indexed (0 = first page, 1 = second page, etc.). Default: 0"
126+
- description: "Page number for pagination. Zero-indexed (0 = first page, 1 =
127+
second page, etc.). Default: 0"
106128
in: query
107129
name: page
108130
schema:
@@ -253,6 +275,3 @@ components:
253275
example: Thank you for joining us today...
254276
type: string
255277
type: object
256-
servers:
257-
- url: https://api.benzinga.com
258-
description: PROD

openapi/logo-api_api.spec.yml

Lines changed: 35 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,25 @@ paths:
1111
description: Bulk logos sync
1212
operationId: logo-bulk-sync
1313
parameters:
14-
- description: Comma-separated list of security identifiers or exchange MIC codes (for v2.1 exchange logos). Type depends on search_keys_type parameter.
14+
- description: Comma-separated list of security identifiers or exchange MIC codes
15+
(for v2.1 exchange logos). Type depends on search_keys_type
16+
parameter.
1517
in: query
1618
name: search_keys
1719
required: true
1820
schema:
1921
type: string
20-
- description: "Type of identifier being searched. Supported types: symbol (default), cik, cusip, isin, exchange (v2.1 only)"
22+
- description: "Type of identifier being searched. Supported types: symbol
23+
(default), cik, cusip, isin, exchange (v2.1 only)"
2124
in: query
2225
name: search_keys_type
2326
schema:
2427
type: string
25-
- description: "Comma-separated list of logo fields to return. Maximum 12 fields. Available: 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, mark_vector_composite_light, mark_vector_composite_dark, colors"
28+
- description: "Comma-separated list of logo fields to return. Maximum 12 fields.
29+
Available: logo_light, logo_dark, logo_vector_light,
30+
logo_vector_dark, mark_light, mark_dark, mark_vector_light,
31+
mark_vector_dark, mark_composite_light, mark_composite_dark,
32+
mark_vector_composite_light, mark_vector_composite_dark, colors"
2633
in: query
2734
name: fields
2835
required: true
@@ -32,7 +39,8 @@ paths:
3239
type: array
3340
items:
3441
type: string
35-
- description: Page number for pagination. Used with pagesize for bulk sync operations.
42+
- description: Page number for pagination. Used with pagesize for bulk sync
43+
operations.
3644
in: query
3745
name: page
3846
schema:
@@ -47,12 +55,14 @@ paths:
4755
name: updated_since
4856
schema:
4957
type: string
50-
- description: "Scale image dimensions in WIDTHxHEIGHT format (e.g., 300x300). Images scale down only, never up. Default: 300x300"
58+
- description: "Scale image dimensions in WIDTHxHEIGHT format (e.g., 300x300).
59+
Images scale down only, never up. Default: 300x300"
5160
in: query
5261
name: scale
5362
schema:
5463
type: string
55-
- description: "Border radius for composite images in percentage. Range 0-50 where 50 creates a circle. Default: 0"
64+
- description: "Border radius for composite images in percentage. Range 0-50 where
65+
50 creates a circle. Default: 0"
5666
in: query
5767
name: composite_radius
5868
schema:
@@ -92,34 +102,43 @@ paths:
92102
description: Search Logos
93103
operationId: get-search-logos
94104
parameters:
95-
- description: Comma-separated list of security identifiers. Maximum 100 identifiers. Type depends on search_keys_type parameter.
105+
- description: Comma-separated list of security identifiers. Maximum 100
106+
identifiers. Type depends on search_keys_type parameter.
96107
in: query
97108
name: search_keys
98109
required: true
99110
schema:
100111
type: string
101-
- description: "Type of identifier being searched. Supported types: symbol (default), cik, cusip, isin"
112+
- description: "Type of identifier being searched. Supported types: symbol
113+
(default), cik, cusip, isin"
102114
in: query
103115
name: search_keys_type
104116
schema:
105117
type: string
106-
- description: "Comma-separated list of logo fields to return. Maximum 12 fields. Available: 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, mark_vector_composite_light, mark_vector_composite_dark, colors"
118+
- description: "Comma-separated list of logo fields to return. Maximum 12 fields.
119+
Available: logo_light, logo_dark, logo_vector_light,
120+
logo_vector_dark, mark_light, mark_dark, mark_vector_light,
121+
mark_vector_dark, mark_composite_light, mark_composite_dark,
122+
mark_vector_composite_light, mark_vector_composite_dark, colors"
107123
in: query
108124
name: fields
109125
required: true
110126
schema:
111127
type: string
112-
- description: If true and no logo exists, generates a composite image based on company name and brand colors
128+
- description: If true and no logo exists, generates a composite image based on
129+
company name and brand colors
113130
in: query
114131
name: composite_auto
115132
schema:
116133
type: boolean
117-
- description: "Border radius for composite images in percentage. Range 0-50 where 50 creates a circle. Default: 0"
134+
- description: "Border radius for composite images in percentage. Range 0-50 where
135+
50 creates a circle. Default: 0"
118136
in: query
119137
name: composite_radius
120138
schema:
121139
type: integer
122-
- description: "Scale image dimensions in WIDTHxHEIGHT format (e.g., 300x300). Images scale down only, never up. Default: 300x300"
140+
- description: "Scale image dimensions in WIDTHxHEIGHT format (e.g., 300x300).
141+
Images scale down only, never up. Default: 300x300"
123142
in: query
124143
name: scale
125144
schema:
@@ -129,14 +148,16 @@ paths:
129148
name: max_width
130149
schema:
131150
type: string
132-
- description: If true, adds flutter_compatible=true query parameter to SVG URLs for flutter_svg library compatibility
151+
- description: If true, adds flutter_compatible=true query parameter to SVG URLs
152+
for flutter_svg library compatibility
133153
in: query
134154
name: flutter_compatible
135155
schema:
136156
type: boolean
137157
responses:
138158
"200":
139-
description: Success response with array of LogoClientResponse objects in data field
159+
description: Success response with array of LogoClientResponse objects in data
160+
field
140161
content:
141162
application/json:
142163
schema:
@@ -222,6 +243,3 @@ components:
222243
ok:
223244
type: boolean
224245
type: object
225-
servers:
226-
- url: https://api.benzinga.com
227-
description: PROD

openapi/news-api_api.spec.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -298,6 +298,3 @@ components:
298298
name:
299299
type: string
300300
type: object
301-
servers:
302-
- url: https://api.benzinga.com
303-
description: PROD

openapi/newsquantified-api_api.spec.yml

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,40 +8,55 @@ info:
88
paths:
99
/api/v2/newsquantified:
1010
get:
11-
description: Retrieves quantified news analytics data with sentiment scores, relevance metrics, and market impact indicators. Returns structured data analyzing the quantitative aspects of news coverage including sentiment polarity, article counts, trending scores, and ticker-specific metrics. Use this endpoint to access machine-readable news analytics for algorithmic trading and quantitative research.
11+
description: Retrieves quantified news analytics data with sentiment scores,
12+
relevance metrics, and market impact indicators. Returns structured data
13+
analyzing the quantitative aspects of news coverage including sentiment
14+
polarity, article counts, trending scores, and ticker-specific metrics.
15+
Use this endpoint to access machine-readable news analytics for
16+
algorithmic trading and quantitative research.
1217
operationId: get-newsquantified-data
1318
parameters:
14-
- description: "Page number for pagination. Zero-indexed (0 = first page, 1 = second page, etc.). Default: 0"
19+
- description: "Page number for pagination. Zero-indexed (0 = first page, 1 =
20+
second page, etc.). Default: 0"
1521
in: query
1622
name: page
1723
schema:
1824
type: integer
19-
- description: "Number of results per page. Default: 1000. Maximum: 1000. Returns most recent data first."
25+
- description: "Number of results per page. Default: 1000. Maximum: 1000. Returns
26+
most recent data first."
2027
in: query
2128
name: pagesize
2229
schema:
2330
type: integer
24-
- description: Unix timestamp in seconds (UTC). Returns newsquantified data updated after this timestamp. Use for incremental updates.
31+
- description: Unix timestamp in seconds (UTC). Returns newsquantified data
32+
updated after this timestamp. Use for incremental updates.
2533
in: query
2634
name: updated_since
2735
schema:
2836
type: integer
29-
- description: Comma-separated list of stock ticker symbols to filter results (e.g., AAPL,MSFT,TSLA). Returns analytics for specified securities only.
37+
- description: Comma-separated list of stock ticker symbols to filter results
38+
(e.g., AAPL,MSFT,TSLA). Returns analytics for specified securities
39+
only.
3040
in: query
3141
name: symbols
3242
schema:
3343
type: string
34-
- description: Single date in YYYY-MM-DD format (e.g., 2024-12-30). Shorthand for filtering when date_from and date_to are the same. Returns data for this specific date.
44+
- description: Single date in YYYY-MM-DD format (e.g., 2024-12-30). Shorthand for
45+
filtering when date_from and date_to are the same. Returns data for
46+
this specific date.
3547
in: query
3648
name: date
3749
schema:
3850
type: string
39-
- description: Start date in YYYY-MM-DD format (e.g., 2024-01-01). Returns data from this date forward. Use with date_to for date range queries.
51+
- description: Start date in YYYY-MM-DD format (e.g., 2024-01-01). Returns data
52+
from this date forward. Use with date_to for date range queries.
4053
in: query
4154
name: date_from
4255
schema:
4356
type: string
44-
- description: End date in YYYY-MM-DD format (e.g., 2024-12-31). Returns data up to and including this date. Use with date_from for date range queries.
57+
- description: End date in YYYY-MM-DD format (e.g., 2024-12-31). Returns data up
58+
to and including this date. Use with date_from for date range
59+
queries.
4560
in: query
4661
name: date_to
4762
schema:
@@ -431,6 +446,3 @@ components:
431446
example: "1.2"
432447
type: string
433448
type: object
434-
servers:
435-
- url: https://api.benzinga.com
436-
description: PROD

0 commit comments

Comments
 (0)