Skip to content

Latest commit

 

History

History
2298 lines (1469 loc) · 56.7 KB

IndexApi.md

File metadata and controls

2298 lines (1469 loc) · 56.7 KB

Intrinio.SDK.Api.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
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 (int? pageSize = null, string nextPage = null)

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

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetAllEconomicIndicesExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      int? pageSize = 100;
      string nextPage = null;
      
      ApiResponseEconomicIndices result = indexApi.GetAllEconomicIndices(pageSize, nextPage);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
pageSize int? 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 (int? pageSize = null, DateTime? startDate = null, DateTime? endDate = null)

All End of Day Index Prices

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetAllEodIndexPricesExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      int? pageSize = 100;
      DateTime? startDate = null;
      DateTime? endDate = null;
      
      ApiResponseEodIndexPricesAll result = indexApi.GetAllEodIndexPrices(pageSize, startDate, endDate);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

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

Return type

ApiResponseEodIndexPricesAll

GetAllIndexSummaries

View Intrinio API Documentation

ApiResponseIndices GetAllIndexSummaries (int? pageSize = null)

All Index Summaries

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetAllIndexSummariesExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      int? pageSize = 100;
      
      ApiResponseIndices result = indexApi.GetAllIndexSummaries(pageSize);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

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

Return type

ApiResponseIndices

GetAllRealtimeIndexPrices

View Intrinio API Documentation

ApiResponseRealtimeIndexPrices GetAllRealtimeIndexPrices (int? pageSize = null)

All Realtime Index Prices

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetAllRealtimeIndexPricesExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      int? pageSize = 100;
      
      ApiResponseRealtimeIndexPrices result = indexApi.GetAllRealtimeIndexPrices(pageSize);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

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

Return type

ApiResponseRealtimeIndexPrices

GetAllSicIndices

View Intrinio API Documentation

ApiResponseSICIndices GetAllSicIndices (int? pageSize = null, string nextPage = null)

All SIC Indices

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetAllSicIndicesExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      int? pageSize = 100;
      string nextPage = null;
      
      ApiResponseSICIndices result = indexApi.GetAllSicIndices(pageSize, nextPage);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
pageSize int? 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 (int? pageSize = null, string nextPage = null)

All Stock Market Indices

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetAllStockMarketIndicesExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      int? pageSize = 100;
      string nextPage = null;
      
      ApiResponseStockMarketIndices result = indexApi.GetAllStockMarketIndices(pageSize, nextPage);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
pageSize int? 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 (string identifier)

Lookup Economic Index

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

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetEconomicIndexByIdExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      string identifier = "$GDP";
      
      EconomicIndex result = indexApi.GetEconomicIndexById(identifier);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

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

Return type

EconomicIndex

GetEconomicIndexDataPointNumber

View Intrinio API Documentation

decimal? GetEconomicIndexDataPointNumber (string identifier, string tag)

Data Point (Number) for an Economic Index

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

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetEconomicIndexDataPointNumberExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      string identifier = "$GDP";
      string tag = "level";
      
      decimal? result = indexApi.GetEconomicIndexDataPointNumber(identifier, tag);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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&#39;&gt;reference&lt;/a>  

Return type

decimal?

GetEconomicIndexDataPointText

View Intrinio API Documentation

string GetEconomicIndexDataPointText (string identifier, string 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

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetEconomicIndexDataPointTextExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      string identifier = "$GDP";
      string tag = "level";
      
      string result = indexApi.GetEconomicIndexDataPointText(identifier, tag);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 (string identifier, string tag, string type = null, DateTime? startDate = null, DateTime? endDate = null, string sortOrder = null, int? pageSize = null, string nextPage = null)

Historical Data for an Economic Index

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

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetEconomicIndexHistoricalDataExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      string identifier = "$GDP";
      string tag = "level";
      string type = null;
      DateTime? startDate = DateTime.Parse("2018-01-01");
      DateTime? endDate = null;
      string sortOrder = "desc";
      int? pageSize = 100;
      string nextPage = null;
      
      ApiResponseEconomicIndexHistoricalData result = indexApi.GetEconomicIndexHistoricalData(identifier, tag, type, startDate, endDate, sortOrder, pageSize, nextPage);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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&#39;&gt;reference&lt;/a>  
type string Filter by type, when applicable [optional]  
startDate DateTime? Get historical data on or after this date [optional]  
endDate DateTime? Get historical data on or before this date [optional]  
sortOrder string Sort by date `asc` or `desc` [optional] [default to desc]  
pageSize int? 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 (string identifier, int? pageSize = null, DateTime? startDate = null, DateTime? endDate = null)

End of Day Index Prices By Identifier

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetEodIndexPriceByIdExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      string identifier = "SPX";
      int? pageSize = 100;
      DateTime? startDate = null;
      DateTime? endDate = null;
      
      ApiResponseEodIndexPrices result = indexApi.GetEodIndexPriceById(identifier, pageSize, startDate, endDate);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

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

Return type

ApiResponseEodIndexPrices

GetIndexConstituentsById

View Intrinio API Documentation

ApiResponseIndexConstituents GetIndexConstituentsById (string identifier)

Index Constituents By Index Identifier

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetIndexConstituentsByIdExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      string identifier = "DJI";
      
      ApiResponseIndexConstituents result = indexApi.GetIndexConstituentsById(identifier);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
identifier string The index symbol  

Return type

ApiResponseIndexConstituents

GetIndexSummaryById

View Intrinio API Documentation

ApiResponseIndex GetIndexSummaryById (string identifier)

Index Summary By Identifier

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetIndexSummaryByIdExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      string identifier = "SPX";
      
      ApiResponseIndex result = indexApi.GetIndexSummaryById(identifier);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
identifier string The index symbol  

Return type

ApiResponseIndex

GetRealtimeIndexPriceById

View Intrinio API Documentation

RealtimeIndexPrice GetRealtimeIndexPriceById (string identifier)

Realtime Index Price By Identifier

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetRealtimeIndexPriceByIdExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      string identifier = "SPX";
      
      RealtimeIndexPrice result = indexApi.GetRealtimeIndexPriceById(identifier);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
identifier string The index symbol  

Return type

RealtimeIndexPrice

GetSicIndexById

View Intrinio API Documentation

SICIndex GetSicIndexById (string identifier)

Lookup SIC Index

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetSicIndexByIdExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      string identifier = "$SIC.2911";
      
      SICIndex result = indexApi.GetSicIndexById(identifier);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

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

Return type

SICIndex

GetSicIndexDataPointNumber

View Intrinio API Documentation

decimal? GetSicIndexDataPointNumber (string identifier, string 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

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetSicIndexDataPointNumberExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      string identifier = "$SIC.2911";
      string tag = "marketcap";
      
      decimal? result = indexApi.GetSicIndexDataPointNumber(identifier, tag);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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

decimal?

GetSicIndexDataPointText

View Intrinio API Documentation

string GetSicIndexDataPointText (string identifier, string 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

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetSicIndexDataPointTextExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      string identifier = "$SIC.2911";
      string tag = "marketcap";
      
      string result = indexApi.GetSicIndexDataPointText(identifier, tag);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 (string identifier, string tag, string type = null, DateTime? startDate = null, DateTime? endDate = null, string sortOrder = null, int? pageSize = null, string nextPage = null)

Historical Data for an SIC Index

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

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetSicIndexHistoricalDataExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      string identifier = "$SIC.1";
      string tag = "marketcap";
      string type = null;
      DateTime? startDate = DateTime.Parse("2018-01-01");
      DateTime? endDate = null;
      string sortOrder = "desc";
      int? pageSize = 100;
      string nextPage = null;
      
      ApiResponseSICIndexHistoricalData result = indexApi.GetSicIndexHistoricalData(identifier, tag, type, startDate, endDate, sortOrder, pageSize, nextPage);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 DateTime? Get historical data on or after this date [optional]  
endDate DateTime? Get historical data on or before this date [optional]  
sortOrder string Sort by date `asc` or `desc` [optional] [default to desc]  
pageSize int? 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 (string identifier)

Lookup Stock Market Index

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetStockMarketIndexByIdExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      string identifier = "$DJI";
      
      StockMarketIndex result = indexApi.GetStockMarketIndexById(identifier);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

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

Return type

StockMarketIndex

GetStockMarketIndexDataPointNumber

View Intrinio API Documentation

decimal? GetStockMarketIndexDataPointNumber (string identifier, string 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

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetStockMarketIndexDataPointNumberExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      string identifier = "$DJI";
      string tag = "level";
      
      decimal? result = indexApi.GetStockMarketIndexDataPointNumber(identifier, tag);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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

decimal?

GetStockMarketIndexDataPointText

View Intrinio API Documentation

string GetStockMarketIndexDataPointText (string identifier, string 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

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetStockMarketIndexDataPointTextExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      string identifier = "$DJI";
      string tag = "level";
      
      string result = indexApi.GetStockMarketIndexDataPointText(identifier, tag);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 (string identifier, string tag, string type = null, DateTime? startDate = null, DateTime? endDate = null, string sortOrder = null, int? pageSize = null, string nextPage = null)

Historical Data for Stock Market Index

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

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetStockMarketIndexHistoricalDataExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      string identifier = "$DJI";
      string tag = "level";
      string type = null;
      DateTime? startDate = DateTime.Parse("2018-01-01");
      DateTime? endDate = null;
      string sortOrder = "desc";
      int? pageSize = 100;
      string nextPage = null;
      
      ApiResponseStockMarketIndexHistoricalData result = indexApi.GetStockMarketIndexHistoricalData(identifier, tag, type, startDate, endDate, sortOrder, pageSize, nextPage);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 DateTime? Get historical data on or after this date [optional]  
endDate DateTime? Get historical data on or before this date [optional]  
sortOrder string Sort by date `asc` or `desc` [optional] [default to desc]  
pageSize int? 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 (string query, int? pageSize = null)

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

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class SearchEconomicIndicesExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      string query = "GDP";
      int? pageSize = 100;
      
      ApiResponseEconomicIndicesSearch result = indexApi.SearchEconomicIndices(query, pageSize);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
query string Search query  
pageSize int? The number of results to return [optional] [default to 100]  

Return type

ApiResponseEconomicIndicesSearch

SearchSicIndices

View Intrinio API Documentation

ApiResponseSICIndicesSearch SearchSicIndices (string query, int? pageSize = null)

Search SIC Indices

Searches for indices using the text in query

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class SearchSicIndicesExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      string query = "agriculture";
      int? pageSize = 100;
      
      ApiResponseSICIndicesSearch result = indexApi.SearchSicIndices(query, pageSize);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
query string Search query  
pageSize int? The number of results to return [optional] [default to 100]  

Return type

ApiResponseSICIndicesSearch

SearchStockMarketsIndices

View Intrinio API Documentation

ApiResponseStockMarketIndicesSearch SearchStockMarketsIndices (string query, int? pageSize = null)

Search Stock Market Indices

Searches for indices using the text in query

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class SearchStockMarketsIndicesExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var indexApi = new IndexApi();
      
      string query = "dow";
      int? pageSize = 100;
      
      ApiResponseStockMarketIndicesSearch result = indexApi.SearchStockMarketsIndices(query, pageSize);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
query string Search query  
pageSize int? The number of results to return [optional] [default to 100]  

Return type

ApiResponseStockMarketIndicesSearch