IndexApi

All URIs are relative to https://api-v2.intrinio.com

Method	HTTP request	Description
getAllEconomicIndices	GET /indices/economic	All Economic Indices
getAllEodIndexPrices	GET /indices/prices/eod	All End of Day Index Prices
getAllIndexSummaries	GET /indices	All Index Summaries
getAllRealtimeIndexPrices	GET /indices/prices/realtime	All Realtime Index Prices
getAllSicIndices	GET /indices/sic	All SIC Indices
getAllStockMarketIndices	GET /indices/stock_market	All Stock Market Indices
getEconomicIndexById	GET /indices/economic/{identifier}	Lookup Economic Index
getEconomicIndexDataPointNumber	GET /indices/economic/{identifier}/data_point/{tag}/number	Data Point (Number) for an Economic Index
getEconomicIndexDataPointText	GET /indices/economic/{identifier}/data_point/{tag}/text	Data Point (Text) for an Economic Index
getEconomicIndexHistoricalData	GET /indices/economic/{identifier}/historical_data/{tag}	Historical Data for an Economic Index
getEodIndexPriceById	GET /indices/{identifier}/eod	End of Day Index Prices By Identifier
getIndexConstituentsById	GET /indices/{identifier}/constituents	Index Constituents By Index Identifier
getIndexIntervals	GET /indices/{identifier}/intervals	Index Intervals
getIndexSummaryById	GET /indices/{identifier}	Index Summary By Identifier
getRealtimeIndexPriceById	GET /indices/{identifier}/realtime	Realtime Index Price By Identifier
getSicIndexById	GET /indices/sic/{identifier}	Lookup SIC Index
getSicIndexDataPointNumber	GET /indices/sic/{identifier}/data_point/{tag}/number	Data Point (Number) for an SIC Index
getSicIndexDataPointText	GET /indices/sic/{identifier}/data_point/{tag}/text	Data Point (Text) for an SIC Index
getSicIndexHistoricalData	GET /indices/sic/{identifier}/historical_data/{tag}	Historical Data for an SIC Index
getStockMarketIndexById	GET /indices/stock_market/{identifier}	Lookup Stock Market Index
getStockMarketIndexDataPointNumber	GET /indices/stock_market/{identifier}/data_point/{tag}/number	Data Point (Number) for Stock Market Index
getStockMarketIndexDataPointText	GET /indices/stock_market/{identifier}/data_point/{tag}/text	Data Point (Text) for Stock Market Index
getStockMarketIndexHistoricalData	GET /indices/stock_market/{identifier}/historical_data/{tag}	Historical Data for Stock Market Index
searchEconomicIndices	GET /indices/economic/search	Search Economic Indices
searchSicIndices	GET /indices/sic/search	Search SIC Indices
searchStockMarketsIndices	GET /indices/stock_market/search	Search Stock Market Indices

getAllEconomicIndices

View Intrinio API Documentation

ApiResponseEconomicIndices getAllEconomicIndices(pageSize, nextPage)

All Economic Indices

Returns a list of reference data on more than 200,000 economic indices from the Federal Reserve Economic Data (FRED) database.

Example

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);

    IndexApi indexApi = new IndexApi();
    Integer pageSize = 100;
    String nextPage = null;
    ApiResponseEconomicIndices result = indexApi.getAllEconomicIndices(pageSize, nextPage);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
pageSize	Integer	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseEconomicIndices

getAllEodIndexPrices

View Intrinio API Documentation

ApiResponseEodIndexPricesAll getAllEodIndexPrices(pageSize, startDate, endDate)

All End of Day Index Prices

Example

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);

    IndexApi indexApi = new IndexApi();
    Integer pageSize = 100;
    LocalDate startDate = null;
    LocalDate endDate = null;
    ApiResponseEodIndexPricesAll result = indexApi.getAllEodIndexPrices(pageSize, startDate, endDate);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
pageSize	Integer	The number of results to return	[optional] [default to 100]
startDate	LocalDate	Limit prices to those on or after this date	[optional]
endDate	LocalDate	Limit prices to those on or before this date	[optional]

Return type

ApiResponseEodIndexPricesAll

getAllIndexSummaries

View Intrinio API Documentation

ApiResponseIndices getAllIndexSummaries(pageSize)

All Index Summaries

Example

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);

    IndexApi indexApi = new IndexApi();
    Integer pageSize = 100;
    ApiResponseIndices result = indexApi.getAllIndexSummaries(pageSize);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
pageSize	Integer	The number of results to return	[optional] [default to 100]

Return type

ApiResponseIndices

getAllRealtimeIndexPrices

View Intrinio API Documentation

ApiResponseRealtimeIndexPrices getAllRealtimeIndexPrices(pageSize)

All Realtime Index Prices

Example

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);

    IndexApi indexApi = new IndexApi();
    Integer pageSize = 100;
    ApiResponseRealtimeIndexPrices result = indexApi.getAllRealtimeIndexPrices(pageSize);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
pageSize	Integer	The number of results to return	[optional] [default to 100]

Return type

ApiResponseRealtimeIndexPrices

getAllSicIndices

View Intrinio API Documentation

ApiResponseSICIndices getAllSicIndices(pageSize, nextPage)

All SIC Indices

Example

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);

    IndexApi indexApi = new IndexApi();
    Integer pageSize = 100;
    String nextPage = null;
    ApiResponseSICIndices result = indexApi.getAllSicIndices(pageSize, nextPage);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
pageSize	Integer	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSICIndices

getAllStockMarketIndices

View Intrinio API Documentation

ApiResponseStockMarketIndices getAllStockMarketIndices(pageSize, nextPage)

All Stock Market Indices

Example

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);

    IndexApi indexApi = new IndexApi();
    Integer pageSize = 100;
    String nextPage = null;
    ApiResponseStockMarketIndices result = indexApi.getAllStockMarketIndices(pageSize, nextPage);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
pageSize	Integer	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseStockMarketIndices

getEconomicIndexById

View Intrinio API Documentation

EconomicIndex getEconomicIndexById(identifier)

Lookup Economic Index

Returns reference data for a specified Federal Reserve Economic Data (FRED) series ID.

Example

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);

    IndexApi indexApi = new IndexApi();
    String identifier = "$GDP";
    EconomicIndex result = indexApi.getEconomicIndexById(identifier);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
identifier	String	An Index Identifier (symbol, Intrinio ID)

Return type

EconomicIndex

getEconomicIndexDataPointNumber

View Intrinio API Documentation

BigDecimal getEconomicIndexDataPointNumber(identifier, tag)

Data Point (Number) for an Economic Index

Returns latest data for a specified Federal Reserve Economic Data (FRED) ID.

Example

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);

    IndexApi indexApi = new IndexApi();
    String identifier = "$GDP";
    String tag = "level";
    BigDecimal result = indexApi.getEconomicIndexDataPointNumber(identifier, tag);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
identifier	String	An Index Identifier (symbol, Intrinio ID)
tag	String	An Intrinio data tag <a href='https://data.intrinio.com/data-tags/economic'>reference</a>

Return type

BigDecimal

getEconomicIndexDataPointText

View Intrinio API Documentation

String getEconomicIndexDataPointText(identifier, tag)

Data Point (Text) for an Economic Index

Returns a text value for the given `tag` for the Economic Index with the given `identifier`

Example

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);

    IndexApi indexApi = new IndexApi();
    String identifier = "$GDP";
    String tag = "level";
    String result = indexApi.getEconomicIndexDataPointText(identifier, tag);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
identifier	String	An Index Identifier (symbol, Intrinio ID)
tag	String	An Intrinio data tag ID or code-name

Return type

String

getEconomicIndexHistoricalData

View Intrinio API Documentation

ApiResponseEconomicIndexHistoricalData getEconomicIndexHistoricalData(identifier, tag, type, startDate, endDate, sortOrder, pageSize, nextPage)

Historical Data for an Economic Index

Returns historical data for a specified Federal Reserve Economic Data (FRED) ID over a period of time.

Example

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);

    IndexApi indexApi = new IndexApi();
    String identifier = "$GDP";
    String tag = "level";
    String type = null;
    LocalDate startDate = LocalDate.of(2018,1,01);
    LocalDate endDate = null;
    String sortOrder = "desc";
    Integer pageSize = 100;
    String nextPage = null;
    ApiResponseEconomicIndexHistoricalData result = indexApi.getEconomicIndexHistoricalData(identifier, tag, type, startDate, endDate, sortOrder, pageSize, nextPage);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
identifier	String	An Index Identifier (symbol, Intrinio ID)
tag	String	An Intrinio data tag <a href='https://data.intrinio.com/data-tags/economic'>reference</a>
type	String	Filter by type, when applicable	[optional]
startDate	LocalDate	Get historical data on or after this date	[optional]
endDate	LocalDate	Get historical data on or before this date	[optional]
sortOrder	String	Sort by date `asc` or `desc`	[optional] [default to desc] [enum: asc, desc]
pageSize	Integer	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseEconomicIndexHistoricalData

getEodIndexPriceById

View Intrinio API Documentation

ApiResponseEodIndexPrices getEodIndexPriceById(identifier, pageSize, startDate, endDate)

End of Day Index Prices By Identifier

Example

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);

    IndexApi indexApi = new IndexApi();
    String identifier = "SPX";
    Integer pageSize = 100;
    LocalDate startDate = null;
    LocalDate endDate = null;
    ApiResponseEodIndexPrices result = indexApi.getEodIndexPriceById(identifier, pageSize, startDate, endDate);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
identifier	String	The index symbol
pageSize	Integer	The number of results to return	[optional] [default to 100]
startDate	LocalDate	Limit prices to those on or after this date	[optional]
endDate	LocalDate	Limit prices to those on or before this date	[optional]

Return type

ApiResponseEodIndexPrices

getIndexConstituentsById

View Intrinio API Documentation

ApiResponseIndexConstituents getIndexConstituentsById(identifier)

Index Constituents By Index Identifier

Example

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);

    IndexApi indexApi = new IndexApi();
    String identifier = "DJI";
    ApiResponseIndexConstituents result = indexApi.getIndexConstituentsById(identifier);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
identifier	String	The index symbol

Return type

ApiResponseIndexConstituents

getIndexIntervals

View Intrinio API Documentation

ApiResponseIndexIntervals getIndexIntervals(identifier, intervalSize, startDate, startTime, endDate, endTime, timezone, pageSize)

Index Intervals

Returns a list of interval data points for a specified index, including open, close, high, low, volume, and average price. Intervals are available in 60-minute, 30-minute, 15-minute, 10-minute, 5-minute, and 1-minute increments.

Example

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);

    IndexApi indexApi = new IndexApi();
    String identifier = "SPX";
    String intervalSize = "5m";
    LocalDate startDate = LocalDate.of(2023,1,01);
    String startTime = "33300";
    LocalDate endDate = LocalDate.of(2023,2,01);
    String endTime = "33300";
    String timezone = "UTC";
    Integer pageSize = 100;
    ApiResponseIndexIntervals result = indexApi.getIndexIntervals(identifier, intervalSize, startDate, startTime, endDate, endTime, timezone, pageSize);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
identifier	String	The index identifier
intervalSize	String	The interval size to return in minutes (m) or hour (h).	[default to 5m] [enum: 1m, 5m, 10m, 15m, 30m, 60m, 1h]
startDate	LocalDate	Return intervals starting at the specified date	[optional]
startTime	String	Return intervals starting at the specified time on the `start_date` (24-hour in 'hh:mm:ss' format)	[optional]
endDate	LocalDate	Return intervals stopping at the specified date	[optional]
endTime	String	Return intervals stopping at the specified time on the `end_date` (24-hour in 'hh:mm:ss' format)	[optional]
timezone	String	Interprets the input times in this time zone, as well as returns times in this timezone.	[optional] [default to UTC] [enum: Africa/Algiers, Africa/Cairo, Africa/Casablanca, Africa/Harare, Africa/Johannesburg, Africa/Monrovia, Africa/Nairobi, America/Argentina/Buenos_Aires, America/Bogota, America/Caracas, America/Chicago, America/Chihuahua, America/Denver, America/Godthab, America/Guatemala, America/Guyana, America/Halifax, America/Indiana/Indianapolis, America/Juneau, America/La_Paz, America/Lima, America/Lima, America/Los_Angeles, America/Mazatlan, America/Mexico_City, America/Mexico_City, America/Monterrey, America/Montevideo, America/New_York, America/Phoenix, America/Regina, America/Santiago, America/Sao_Paulo, America/St_Johns, America/Tijuana, Asia/Almaty, Asia/Baghdad, Asia/Baku, Asia/Bangkok, Asia/Bangkok, Asia/Chongqing, Asia/Colombo, Asia/Dhaka, Asia/Dhaka, Asia/Hong_Kong, Asia/Irkutsk, Asia/Jakarta, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Karachi, Asia/Kathmandu, Asia/Kolkata, Asia/Kolkata, Asia/Kolkata, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuwait, Asia/Magadan, Asia/Muscat, Asia/Muscat, Asia/Novosibirsk, Asia/Rangoon, Asia/Riyadh, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tokyo, Asia/Tokyo, Asia/Tokyo, Asia/Ulaanbaatar, Asia/Urumqi, Asia/Vladivostok, Asia/Yakutsk, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Cape_Verde, Atlantic/South_Georgia, Australia/Adelaide, Australia/Brisbane, Australia/Darwin, Australia/Hobart, Australia/Melbourne, Australia/Melbourne, Australia/Perth, Australia/Sydney, Etc/UTC, UTC, Europe/Amsterdam, Europe/Athens, Europe/Belgrade, Europe/Berlin, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Copenhagen, Europe/Dublin, Europe/Helsinki, Europe/Istanbul, Europe/Kaliningrad, Europe/Kiev, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/London, Europe/Madrid, Europe/Minsk, Europe/Moscow, Europe/Moscow, Europe/Paris, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/Sarajevo, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Pacific/Apia, Pacific/Auckland, Pacific/Auckland, Pacific/Chatham, Pacific/Fakaofo, Pacific/Fiji, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Majuro, Pacific/Midway, Pacific/Midway, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Port_Moresby, Pacific/Tongatapu]
pageSize	Integer	The number of results to return per page.	[optional] [default to 100]

Return type

ApiResponseIndexIntervals

getIndexSummaryById

View Intrinio API Documentation

ApiResponseIndex getIndexSummaryById(identifier)

Index Summary By Identifier

Example

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);

    IndexApi indexApi = new IndexApi();
    String identifier = "SPX";
    ApiResponseIndex result = indexApi.getIndexSummaryById(identifier);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
identifier	String	The index symbol

Return type

ApiResponseIndex

getRealtimeIndexPriceById

View Intrinio API Documentation

RealtimeIndexPrice getRealtimeIndexPriceById(identifier)

Realtime Index Price By Identifier

Returns the realtime price for an index.

Example

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);

    IndexApi indexApi = new IndexApi();
    String identifier = "SPX";
    RealtimeIndexPrice result = indexApi.getRealtimeIndexPriceById(identifier);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
identifier	String	The index symbol

Return type

RealtimeIndexPrice

getSicIndexById

View Intrinio API Documentation

SICIndex getSicIndexById(identifier)

Lookup SIC Index

Example

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);

    IndexApi indexApi = new IndexApi();
    String identifier = "$SIC.2911";
    SICIndex result = indexApi.getSicIndexById(identifier);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
identifier	String	An Index Identifier (symbol, Intrinio ID)

Return type

SICIndex

getSicIndexDataPointNumber

View Intrinio API Documentation

BigDecimal getSicIndexDataPointNumber(identifier, tag)

Data Point (Number) for an SIC Index

Returns a numeric value for the given `tag` for the SIC Index with the given `identifier`

Example

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);

    IndexApi indexApi = new IndexApi();
    String identifier = "$SIC.2911";
    String tag = "marketcap";
    BigDecimal result = indexApi.getSicIndexDataPointNumber(identifier, tag);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
identifier	String	An Index Identifier (symbol, Intrinio ID)
tag	String	An Intrinio data tag ID or code-name

Return type

BigDecimal

getSicIndexDataPointText

View Intrinio API Documentation

String getSicIndexDataPointText(identifier, tag)

Data Point (Text) for an SIC Index

Returns a text value for the given `tag` for the SIC Index with the given `identifier`

Example

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);

    IndexApi indexApi = new IndexApi();
    String identifier = "$SIC.2911";
    String tag = "marketcap";
    String result = indexApi.getSicIndexDataPointText(identifier, tag);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
identifier	String	An Index Identifier (symbol, Intrinio ID)
tag	String	An Intrinio data tag ID or code-name

Return type

String

getSicIndexHistoricalData

View Intrinio API Documentation

ApiResponseSICIndexHistoricalData getSicIndexHistoricalData(identifier, tag, type, startDate, endDate, sortOrder, pageSize, nextPage)

Historical Data for an SIC Index

Returns historical values for the given `tag` and the SIC Index with the given `identifier`

Example

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);

    IndexApi indexApi = new IndexApi();
    String identifier = "$SIC.1";
    String tag = "marketcap";
    String type = null;
    LocalDate startDate = LocalDate.of(2018,1,01);
    LocalDate endDate = null;
    String sortOrder = "desc";
    Integer pageSize = 100;
    String nextPage = null;
    ApiResponseSICIndexHistoricalData result = indexApi.getSicIndexHistoricalData(identifier, tag, type, startDate, endDate, sortOrder, pageSize, nextPage);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
identifier	String	An Index Identifier (symbol, Intrinio ID)
tag	String	An Intrinio data tag ID or code-name
type	String	Filter by type, when applicable	[optional]
startDate	LocalDate	Get historical data on or after this date	[optional]
endDate	LocalDate	Get historical data on or before this date	[optional]
sortOrder	String	Sort by date `asc` or `desc`	[optional] [default to desc] [enum: asc, desc]
pageSize	Integer	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSICIndexHistoricalData

getStockMarketIndexById

View Intrinio API Documentation

StockMarketIndex getStockMarketIndexById(identifier)

Lookup Stock Market Index

Example

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);

    IndexApi indexApi = new IndexApi();
    String identifier = "$DJI";
    StockMarketIndex result = indexApi.getStockMarketIndexById(identifier);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
identifier	String	An Index Identifier (symbol, Intrinio ID)

Return type

StockMarketIndex

getStockMarketIndexDataPointNumber

View Intrinio API Documentation

BigDecimal getStockMarketIndexDataPointNumber(identifier, tag)

Data Point (Number) for Stock Market Index

Returns a numeric value for the given `tag` for the Stock Market Index with the given `identifier`

Example

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);

    IndexApi indexApi = new IndexApi();
    String identifier = "$DJI";
    String tag = "level";
    BigDecimal result = indexApi.getStockMarketIndexDataPointNumber(identifier, tag);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
identifier	String	An Index Identifier (symbol, Intrinio ID)
tag	String	An Intrinio data tag ID or code-name

Return type

BigDecimal

getStockMarketIndexDataPointText

View Intrinio API Documentation

String getStockMarketIndexDataPointText(identifier, tag)

Data Point (Text) for Stock Market Index

Returns a text value for the given `tag` for the Stock Market Index with the given `identifier`

Example

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);

    IndexApi indexApi = new IndexApi();
    String identifier = "$DJI";
    String tag = "level";
    String result = indexApi.getStockMarketIndexDataPointText(identifier, tag);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
identifier	String	An Index Identifier (symbol, Intrinio ID)
tag	String	An Intrinio data tag ID or code-name

Return type

String

getStockMarketIndexHistoricalData

View Intrinio API Documentation

ApiResponseStockMarketIndexHistoricalData getStockMarketIndexHistoricalData(identifier, tag, type, startDate, endDate, sortOrder, pageSize, nextPage)

Historical Data for Stock Market Index

Returns historical values for the given `tag` and the Stock Market Index with the given `identifier`

Example

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);

    IndexApi indexApi = new IndexApi();
    String identifier = "$DJI";
    String tag = "level";
    String type = null;
    LocalDate startDate = LocalDate.of(2018,1,01);
    LocalDate endDate = null;
    String sortOrder = "desc";
    Integer pageSize = 100;
    String nextPage = null;
    ApiResponseStockMarketIndexHistoricalData result = indexApi.getStockMarketIndexHistoricalData(identifier, tag, type, startDate, endDate, sortOrder, pageSize, nextPage);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
identifier	String	An Index Identifier (symbol, Intrinio ID)
tag	String	An Intrinio data tag ID or code-name
type	String	Filter by type, when applicable	[optional]
startDate	LocalDate	Get historical data on or after this date	[optional]
endDate	LocalDate	Get historical data on or before this date	[optional]
sortOrder	String	Sort by date `asc` or `desc`	[optional] [default to desc] [enum: asc, desc]
pageSize	Integer	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseStockMarketIndexHistoricalData

searchEconomicIndices

View Intrinio API Documentation

ApiResponseEconomicIndicesSearch searchEconomicIndices(query, pageSize)

Search Economic Indices

Search the Federal Reserve Economic Data (FRED) database and return a list of economic indices matching the text query parameter passed through.

Example

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);

    IndexApi indexApi = new IndexApi();
    String query = "GDP";
    Integer pageSize = 100;
    ApiResponseEconomicIndicesSearch result = indexApi.searchEconomicIndices(query, pageSize);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
query	String	Search query
pageSize	Integer	The number of results to return	[optional] [default to 100]

Return type

ApiResponseEconomicIndicesSearch

searchSicIndices

View Intrinio API Documentation

ApiResponseSICIndicesSearch searchSicIndices(query, pageSize)

Search SIC Indices

Searches for indices using the text in `query`

Example

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);

    IndexApi indexApi = new IndexApi();
    String query = "agriculture";
    Integer pageSize = 100;
    ApiResponseSICIndicesSearch result = indexApi.searchSicIndices(query, pageSize);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
query	String	Search query
pageSize	Integer	The number of results to return	[optional] [default to 100]

Return type

ApiResponseSICIndicesSearch

searchStockMarketsIndices

View Intrinio API Documentation

ApiResponseStockMarketIndicesSearch searchStockMarketsIndices(query, pageSize)

Search Stock Market Indices

Searches for indices using the text in `query`

Example

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);

    IndexApi indexApi = new IndexApi();
    String query = "dow";
    Integer pageSize = 100;
    ApiResponseStockMarketIndicesSearch result = indexApi.searchStockMarketsIndices(query, pageSize);
    System.out.println(result);
  }
}

Parameters

Name	Type	Description	Notes
query	String	Search query
pageSize	Integer	The number of results to return	[optional] [default to 100]

Return type

ApiResponseStockMarketIndicesSearch

FilesExpand file tree

IndexApi.md

Latest commit

History

IndexApi.md

File metadata and controls

IndexApi

getAllEconomicIndices

All Economic Indices

Example

Parameters

Return type

getAllEodIndexPrices

All End of Day Index Prices

Example

Parameters

Return type

getAllIndexSummaries

All Index Summaries

Example

Parameters

Return type

getAllRealtimeIndexPrices

All Realtime Index Prices

Example

Parameters

Return type

getAllSicIndices

All SIC Indices

Example

Parameters

Return type

getAllStockMarketIndices

All Stock Market Indices

Example

Parameters

Return type

getEconomicIndexById

Lookup Economic Index

Example

Parameters

Return type

getEconomicIndexDataPointNumber

Data Point (Number) for an Economic Index

Example

Parameters

Return type

getEconomicIndexDataPointText

Data Point (Text) for an Economic Index

Example

Parameters

Return type

getEconomicIndexHistoricalData

Historical Data for an Economic Index

Example

Parameters

Return type

getEodIndexPriceById

End of Day Index Prices By Identifier

Example

Parameters

Return type

getIndexConstituentsById

Index Constituents By Index Identifier

Example

Parameters

Return type

getIndexIntervals

Index Intervals

Example

Parameters

Return type

getIndexSummaryById

Index Summary By Identifier

Example

Parameters

Return type

getRealtimeIndexPriceById

Realtime Index Price By Identifier

Example