Skip to content

Commit 4cfa9ed

Browse files
committed
feat: Add option contract for trading api
1 parent 0e43586 commit 4cfa9ed

13 files changed

Lines changed: 606 additions & 24 deletions

File tree

‎pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<groupId>com.webull.openapi</groupId>
2222
<artifactId>webull-openapi-java-sdk-parent</artifactId>
2323
<packaging>pom</packaging>
24-
<version>1.1.15</version>
24+
<version>1.1.16</version>
2525

2626
<name>webull-openapi-java-sdk-parent</name>
2727
<url>https://github.com/webull-inc/webull-openapi-java-sdk/</url>

‎webull-openapi-java-sdk-samples/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
<parent>
2020
<groupId>com.webull.openapi</groupId>
2121
<artifactId>webull-openapi-java-sdk-parent</artifactId>
22-
<version>1.1.15</version>
22+
<version>1.1.16</version>
2323
</parent>
2424
<modelVersion>4.0.0</modelVersion>
2525

‎webull-openapi-java-sdk-samples/src/main/java/com/webull/openapi/samples/data/DataClient.java‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
import com.webull.openapi.samples.config.Env;
1919

2020
import java.util.*;
21+
import java.math.BigDecimal;
2122

2223
public class DataClient {
2324

@@ -269,6 +270,13 @@ public static void main(String[] args) {
269270
FiftyTwoWeekResponse newHighs = dataClient.get52Whl(FiftyTwoWeekRankType.NEW_HIGH.name(), Category.US_STOCK.name(), ScreenerOrderBy.CHANGE_RATIO_52W.name(), 1, 10, SortDirection.DESC.name());
270271
logger.info("52-Week New Highs: {}", newHighs);
271272

273+
// Get option contracts
274+
OptionContractQueryParam optionParam = new OptionContractQueryParam();
275+
optionParam.setCategory(Category.US_OPTION.name());
276+
optionParam.setUnderlyingSymbols("AAPL");
277+
List<OptionContract> optionContracts = dataClient.getOptionContracts(optionParam);
278+
logger.info("Option Contracts: {}", optionContracts);
279+
272280

273281
// // get end of day market
274282
// List<EodBars> eodBars = IDataClient.getEodBars(instrumentIds, "2023-01-01", 10);

‎webull-openapi-java-sdk/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<parent>
88
<groupId>com.webull.openapi</groupId>
99
<artifactId>webull-openapi-java-sdk-parent</artifactId>
10-
<version>1.1.15</version>
10+
<version>1.1.16</version>
1111
</parent>
1212

1313
<artifactId>webull-openapi-java-sdk</artifactId>

‎webull-openapi-java-sdk/src/main/java/com/webull/openapi/core/auth/composer/DefaultSignatureComposer.java‎

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,6 @@ public class DefaultSignatureComposer {
3838
private static final String PARAMS_JOIN = "&";
3939
private static final String SECRET_TAILER = "&";
4040
private static final String PARAM_KV_JOIN = "=";
41-
private static final List<String> NOT_UPGRADE_SIGN_REGIONS =
42-
Arrays.asList(DefaultHost.API_US,DefaultHost.EVENTS_US,
43-
PreDefaultHost.API_US,PreDefaultHost.EVENTS_US,
44-
UatDefaultHost.API_US,UatDefaultHost.EVENTS_US,
45-
DefaultHost.API_HK,DefaultHost.EVENTS_HK,
46-
PreDefaultHost.API_HK,PreDefaultHost.EVENTS_HK,
47-
UatDefaultHost.API_HK,UatDefaultHost.EVENTS_HK,
48-
DefaultHost.API_HK_SANDBOX,DefaultHost.EVENTS_HK_SANDBOX);
4941

5042
private DefaultSignatureComposer() {
5143

@@ -104,9 +96,7 @@ public static String getSign(Map<String, String> signParams, String url, String
10496

10597
public static String getSign(String host, String appKey, String appSecret, HttpRequest request) {
10698
//Upgrade encryption algorithm regions
107-
if (!NOT_UPGRADE_SIGN_REGIONS.contains(host)) {
108-
request.setSignAlgorithm(SignAlgorithm.HMAC_SHA256);
109-
}
99+
request.setSignAlgorithm(SignAlgorithm.HMAC_SHA256);
110100
Signer signer = SignerFactory.getInstance().get(request.getSignAlgorithm());
111101
Map<String, String> signParams = refreshSignHeaders(host, appKey, request.getHeaders(), signer);
112102
Map<String, Object> queryParams = request.getQuery();

‎webull-openapi-java-sdk/src/main/java/com/webull/openapi/core/config/ProjectReaderHelper.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ private ProjectReaderHelper() {
2424

2525
private static final String APPLICATION_VERSION = "application.version";
2626

27-
private static final String DEFAULT_APPLICATION_VERSION = "1.1.15";
27+
private static final String DEFAULT_APPLICATION_VERSION = "1.1.16";
2828

2929
private static final String APPLICATION_NAME = "application.name";
3030

‎webull-openapi-java-sdk/src/main/java/com/webull/openapi/data/DataClient.java‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1332,4 +1332,60 @@ public NoiiSnapshot getNoiiSnapshot(String symbol, String category, String imbal
13321332
return apiClient.request(request).responseType(new TypeToken<NoiiSnapshot>() {}.getType()).doAction();
13331333
}
13341334

1335+
1336+
// ==================== Option Instrument APIs ====================
1337+
1338+
@Override
1339+
public List<OptionContract> getOptionContracts(OptionContractQueryParam param) {
1340+
Assert.notNull(ArgNames.PARAMETER, param);
1341+
Assert.notBlank(ArgNames.CATEGORY, param.getCategory());
1342+
HttpRequest request = new HttpRequest("/openapi/instrument/option/contracts", Versions.V2, HttpMethod.GET);
1343+
Map<String, Object> params = new HashMap<>();
1344+
params.put(ArgNames.CATEGORY, param.getCategory());
1345+
if (StringUtils.isNotEmpty(param.getUnderlyingSymbols())) {
1346+
params.put(ArgNames.UNDERLYING_SYMBOLS, param.getUnderlyingSymbols());
1347+
}
1348+
if (StringUtils.isNotEmpty(param.getStatus())) {
1349+
params.put(ArgNames.STATUS, param.getStatus());
1350+
}
1351+
if (StringUtils.isNotEmpty(param.getStartDate())) {
1352+
params.put(ArgNames.START_DATE, param.getStartDate());
1353+
}
1354+
if (StringUtils.isNotEmpty(param.getEndDate())) {
1355+
params.put(ArgNames.END_DATE, param.getEndDate());
1356+
}
1357+
if (StringUtils.isNotEmpty(param.getRootSymbol())) {
1358+
params.put(ArgNames.ROOT_SYMBOL, param.getRootSymbol());
1359+
}
1360+
if (StringUtils.isNotEmpty(param.getOptionSymbol())) {
1361+
params.put(ArgNames.OPTION_SYMBOL, param.getOptionSymbol());
1362+
}
1363+
if (StringUtils.isNotEmpty(param.getOptionType())) {
1364+
params.put(ArgNames.OPTION_TYPE, param.getOptionType());
1365+
}
1366+
if (StringUtils.isNotEmpty(param.getStyle())) {
1367+
params.put(ArgNames.STYLE, param.getStyle());
1368+
}
1369+
if (Objects.nonNull(param.getStrikePriceGte())) {
1370+
params.put(ArgNames.STRIKE_PRICE_GTE, param.getStrikePriceGte());
1371+
}
1372+
if (Objects.nonNull(param.getStrikePriceLte())) {
1373+
params.put(ArgNames.STRIKE_PRICE_LTE, param.getStrikePriceLte());
1374+
}
1375+
if (Objects.nonNull(param.getPpind())) {
1376+
params.put(ArgNames.PPIND, param.getPpind());
1377+
}
1378+
if (Objects.nonNull(param.getShowDeliverables())) {
1379+
params.put(ArgNames.SHOW_DELIVERABLES, param.getShowDeliverables());
1380+
}
1381+
if (param.getPageSize() > 0) {
1382+
params.put(ArgNames.PAGE_SIZE, param.getPageSize());
1383+
}
1384+
if (StringUtils.isNotEmpty(param.getLastInstrumentId())) {
1385+
params.put(ArgNames.LAST_INSTRUMENT_ID, param.getLastInstrumentId());
1386+
}
1387+
request.setQuery(params);
1388+
addCustomHeaders(request);
1389+
return apiClient.request(request).responseType(new TypeToken<List<OptionContract>>() {}.getType()).doAction();
1390+
}
13351391
}

‎webull-openapi-java-sdk/src/main/java/com/webull/openapi/data/common/ArgNames.java‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,4 +84,15 @@ private ArgNames() {
8484
public static final String AGG_TYPE = "agg_type";
8585
public static final String PERIOD = "period";
8686
public static final String SECTOR_ID = "sector_id";
87+
88+
// Option contract related
89+
public static final String UNDERLYING_SYMBOLS = "underlying_symbols";
90+
public static final String OPTION_SYMBOL = "option_symbol";
91+
public static final String OPTION_TYPE = "option_type";
92+
public static final String STYLE = "style";
93+
public static final String STRIKE_PRICE_GTE = "strike_price_gte";
94+
public static final String STRIKE_PRICE_LTE = "strike_price_lte";
95+
public static final String ROOT_SYMBOL = "root_symbol";
96+
public static final String PPIND = "ppind";
97+
public static final String SHOW_DELIVERABLES = "show_deliverables";
8798
}

‎webull-openapi-java-sdk/src/main/java/com/webull/openapi/data/quotes/api/IDataClient.java‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -560,4 +560,16 @@ FiftyTwoWeekResponse get52Whl(String rankType, String category, String sortBy,
560560
*/
561561
NoiiSnapshot getNoiiSnapshot(String symbol, String category, String imbalanceActionType);
562562

563+
564+
// ==================== Option Instrument APIs ====================
565+
566+
/**
567+
* Query option contract list by various filters such as underlying symbols, status, expiration date, etc.
568+
*
569+
* @param param Query parameters including category (required, US_OPTION),
570+
* underlying symbols, status, expiration date range, option type, style,
571+
* strike price range, pagination, etc.
572+
* @return List of option contracts matching the query criteria
573+
*/
574+
List<OptionContract> getOptionContracts(OptionContractQueryParam param);
563575
}

0 commit comments

Comments
 (0)