Movers API Reference
This REST API returns structured data for market movers.
API Endpoint
https://api.benzinga.com/api/v1/market
Response Content-Types
application/json
Schemes
https
Version
1.0.0
Authentication
token
authentication
- Type:
- apiKey
- Name:
- apikey
- In:
- query
Playground
Endpoints
GET /movers
Returns market movers
Parameters
Name | Type | Location | Description |
---|---|---|---|
maxResults | integer | query | Max numbers of gainers/losers to return. Limit 1000. |
from | string (YYYY-MM-DD) | query | From session or timestamp.
|
to | string (YYYY-MM-DD) | query | To session or timestamp.
|
session | string (REGULAR | PRE_MARKET | AFTER_MARKET) | query | The market session to report for. PRE_MARKET and AFTER_MARKET will return movers only for the one session. Multi-day movers always use offical regular session closing prices. REGULAR is default. |
screenerQuery | string | query | Filters movers by screener query. A screener query is a list of conditions separated by a semicolon. Some examples
|
Responses
Code | Model | Description |
---|---|---|
200 OK | movers | success |
Response (200 OK)
{
"processingTimeMillis": "integer",
"result": {
"fromDate": "string (Mon Jun 22 2020 20:00:00 GMT+0000 (Coordinated Universal Time))",
"toDate": "string (Mon Jun 22 2020 20:00:00 GMT+0000 (Coordinated Universal Time))",
"snapTo": "string (Snap id=1140563,date=2020-06-23T19:59:00.000Z)",
"usePreviousClose": "boolean",
"gainers": [
{
"symbol": "string",
"change": "number (double)",
"changePercent": "number (double)",
"volume": "number (double)",
"close": "number (double)",
"companyName": "string",
"averageVolume": "integer",
"previousClose": "number (double)"
}
],
"losers": [
{
"symbol": "string",
"change": "number (double)",
"changePercent": "number (double)",
"volume": "number (double)",
"close": "number (double)",
"companyName": "string",
"averageVolume": "integer",
"previousClose": "number (double)"
}
]
}
}
Models
movers: object
Property | Type | Description |
---|---|---|
processingTimeMillis | integer | Informational. The number of milliseconds processing time took on the server. |
result | object | - |
result.fromDate | string (Mon Jun 22 2020 20:00:00 GMT+0000 (Coordinated Universal Time)) | Datetime of the start of the period used to calculate movers. |
result.toDate | string (Mon Jun 22 2020 20:00:00 GMT+0000 (Coordinated Universal Time)) | Datetime of the end of the period used to calculate movers. |
result.snapTo | string (Snap id=1140563,date=2020-06-23T19:59:00.000Z) | - |
result.usePreviousClose | boolean | True if the previous regular session close is being used to calcuated price change fields. |
result.gainers | object[] | - |
result.losers | object[] | - |
Structure (JSON)
{
"processingTimeMillis": "integer",
"result": {
"fromDate": "string (Mon Jun 22 2020 20:00:00 GMT+0000 (Coordinated Universal Time))",
"toDate": "string (Mon Jun 22 2020 20:00:00 GMT+0000 (Coordinated Universal Time))",
"snapTo": "string (Snap id=1140563,date=2020-06-23T19:59:00.000Z)",
"usePreviousClose": "boolean",
"gainers": [
{
"symbol": "string",
"change": "number (double)",
"changePercent": "number (double)",
"volume": "number (double)",
"close": "number (double)",
"companyName": "string",
"averageVolume": "integer",
"previousClose": "number (double)"
}
],
"losers": [
{
"symbol": "string",
"change": "number (double)",
"changePercent": "number (double)",
"volume": "number (double)",
"close": "number (double)",
"companyName": "string",
"averageVolume": "integer",
"previousClose": "number (double)"
}
]
}
}
movers_item: object
Property | Type | Description |
---|---|---|
symbol | string | Ticker Symbol (F, MSFT, etc...) |
change | number (double) | Price change |
changePercent | number (double) | Price change percent |
volume | number (double) | Volume for the instrument over the report period. |
close | number (double) | The last known price (up to a minute delayed if in an active session) of the instrument. |
companyName | string | Company name |
averageVolume | integer | Average 50 date volume for the instrument |
previousClose | number (double) | Previous close price |
Structure (JSON)
{
"symbol": "string",
"change": "number (double)",
"changePercent": "number (double)",
"volume": "number (double)",
"close": "number (double)",
"companyName": "string",
"averageVolume": "integer",
"previousClose": "number (double)"
}