Options Intervals By Contract Java API Documentation

Back to Product Docs

Returns a list of interval data points for a contract.

API Class:

OptionsApi

Instance Method:

getOptionsIntervalByContract()

Stock Price Code Example

Use my API Key

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
27
import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;
public class Main {
  public static void main(String[] args) throws Exception {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);
    OptionsApi optionsApi = new OptionsApi();
    String identifier = "SPY___230103P00380000";
    String intervalSize = "5m";
    String source = null;
    Integer pageSize = 100;
    OffsetDateTime endTime = OffsetDateTime.now();
    OptionIntervalsResult result = optionsApi.getOptionsIntervalByContract(identifier, intervalSize, source, pageSize, endTime);
    System.out.println(result);
  }
}
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

Name	Type	Description	Notes
identifier	String	The Intrinio ID or code of the options contract to request intervals for.
intervalSize	String	The time length of the interval.	[enum: SixtyMinute, 60m, 1h, ThirtyMinute, 30m, FifteenMinute, 15m, TenMinute, 10m, FiveMinute, 5m, OneMinute, 1m]
source	String	Realtime or 15-minute delayed contracts.	[optional] [enum: realtime, delayed]
pageSize	Integer	The number of results to return	[optional] [default to 100]
endTime	OffsetDateTime	The inclusive UTC date and time the intervals end at.	[optional]

Return Type

object

OptionIntervalsResult

Properties

Name	Type	Description
intervals	List	Array of all the intervals in the result.
contract	String	The option contract for the intervals
size	SizeEnum	The size of the time span for the interval.

object

OptionInterval

Properties

Name	Type	Description
openTime	OffsetDateTime	The UTC timestamp for the time this interval opened.
closeTime	OffsetDateTime	The UTC timestamp for the time this interval closed.
open	BigDecimal	The first traded contract price in this interval.
high	BigDecimal	The highest traded contract price in this interval.
low	BigDecimal	The lowest traded contract price in this interval.
close	BigDecimal	The last traded contract price in this interval.
volume	BigDecimal	The volume of contracts traded in this interval.
average	BigDecimal	The volume weighted average price of contract trades in this interval.
change	BigDecimal	The ratio of Close minus Open to Open.
tradeCount	BigDecimal	The number of qualified trades executed during the period

Options Intervals By Contract

SDKs

API Endpoints

Standardized & As-Reported Financial Statement Data

Company Reference & Metadata

Company News

Insider & Institutional Holdings Data

Upcoming & Historical IPOs

Raw Text Filings

XBRL Searchable Financial Statement Notes

Aggregate Standardized Financial Statement Data by SIC Codes

Economic Data

Security Reference Data

Real-Time Prices

Historical Intraday Prices

Historical End of Day Prices

Technical Indicators

Historical End of Day Index Prices

Reference & Metadata

Holdings

Returns & Analytics