Skip to content
This repository has been archived by the owner on Sep 2, 2024. It is now read-only.

Latest commit

 

History

History
315 lines (225 loc) · 9.93 KB

StocksApi.md

File metadata and controls

315 lines (225 loc) · 9.93 KB
Raw

EquiblesStocks.StocksApi

All URIs are relative to https://api.equibles.com

Method HTTP request Description
list GET /stocks/list Get a list of all the available stocks.
officers GET /stocks/officers Get the officers of the company.
profile GET /stocks/profile The profile of this stock.
screener POST /stocks/screener Get a list of stocks constraint to several criteria.
search GET /stocks/search Search among all the available stocks.
splits GET /stocks/splits Get all the splits for a given stock.

list

StockProfilesResponse list(opts)

Get a list of all the available stocks.

Example

import {EquiblesStocks} from 'equibles_stocks';
let defaultClient = EquiblesStocks.ApiClient.instance;

// Configure API key authorization: Query String
let Query String = defaultClient.authentications['Query String'];
Query String.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Query String.apiKeyPrefix = 'Token';

let apiInstance = new EquiblesStocks.StocksApi();
let opts = { 
  'page': 1, // Number | The number of the page to request.
  'pageSize': 100 // Number | The number of elements in each page. Max value: 100.
};
apiInstance.list(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
page Number The number of the page to request. [optional] [default to 1]
pageSize Number The number of elements in each page. Max value: 100. [optional] [default to 100]

Return type

StockProfilesResponse

Authorization

[Query String](../README.md#Query String)

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

officers

OfficersResponse officers(fullTicker)

Get the officers of the company.

Example

import {EquiblesStocks} from 'equibles_stocks';
let defaultClient = EquiblesStocks.ApiClient.instance;

// Configure API key authorization: Query String
let Query String = defaultClient.authentications['Query String'];
Query String.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Query String.apiKeyPrefix = 'Token';

let apiInstance = new EquiblesStocks.StocksApi();
let fullTicker = "fullTicker_example"; // String | The fully qualified ticker of the stock. Example: AAPL.XNAS

apiInstance.officers(fullTicker).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
fullTicker String The fully qualified ticker of the stock. Example: AAPL.XNAS

Return type

OfficersResponse

Authorization

[Query String](../README.md#Query String)

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

profile

StockProfileResponse profile(fullTicker)

The profile of this stock.

Example

import {EquiblesStocks} from 'equibles_stocks';
let defaultClient = EquiblesStocks.ApiClient.instance;

// Configure API key authorization: Query String
let Query String = defaultClient.authentications['Query String'];
Query String.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Query String.apiKeyPrefix = 'Token';

let apiInstance = new EquiblesStocks.StocksApi();
let fullTicker = "fullTicker_example"; // String | The fully qualified ticker of the stock. Example: AAPL.XNAS

apiInstance.profile(fullTicker).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
fullTicker String The fully qualified ticker of the stock. Example: AAPL.XNAS

Return type

StockProfileResponse

Authorization

[Query String](../README.md#Query String)

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

screener

StockProfilesResponse screener(body, opts)

Get a list of stocks constraint to several criteria.

Get a list of the stocks constraint to several criteria. You only need to fill the fields of ScreenerRequest that you want to use as filters.

Example

import {EquiblesStocks} from 'equibles_stocks';
let defaultClient = EquiblesStocks.ApiClient.instance;

// Configure API key authorization: Query String
let Query String = defaultClient.authentications['Query String'];
Query String.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Query String.apiKeyPrefix = 'Token';

let apiInstance = new EquiblesStocks.StocksApi();
let body = new EquiblesStocks.ScreenerRequest(); // ScreenerRequest | The criteria used to filter the search results. You only need to fill the fields that you want to use on the search.
let opts = { 
  'page': 1, // Number | The number of the page to request.
  'pageSize': 100 // Number | The number of elements in each page. Max value: 100.
};
apiInstance.screener(body, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
body ScreenerRequest The criteria used to filter the search results. You only need to fill the fields that you want to use on the search.
page Number The number of the page to request. [optional] [default to 1]
pageSize Number The number of elements in each page. Max value: 100. [optional] [default to 100]

Return type

StockProfilesResponse

Authorization

[Query String](../README.md#Query String)

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
  • Accept: text/plain, application/json, text/json

search

StockProfilesResponse search(text, opts)

Search among all the available stocks.

Example

import {EquiblesStocks} from 'equibles_stocks';
let defaultClient = EquiblesStocks.ApiClient.instance;

// Configure API key authorization: Query String
let Query String = defaultClient.authentications['Query String'];
Query String.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Query String.apiKeyPrefix = 'Token';

let apiInstance = new EquiblesStocks.StocksApi();
let text = "text_example"; // String | The text to search for.
let opts = { 
  'page': 1, // Number | The number of the page to request.
  'pageSize': 100 // Number | The number of elements in each page. Max value: 100.
};
apiInstance.search(text, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
text String The text to search for.
page Number The number of the page to request. [optional] [default to 1]
pageSize Number The number of elements in each page. Max value: 100. [optional] [default to 100]

Return type

StockProfilesResponse

Authorization

[Query String](../README.md#Query String)

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

splits

SplitsResponse splits(fullTicker, opts)

Get all the splits for a given stock.

Example

import {EquiblesStocks} from 'equibles_stocks';
let defaultClient = EquiblesStocks.ApiClient.instance;

// Configure API key authorization: Query String
let Query String = defaultClient.authentications['Query String'];
Query String.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Query String.apiKeyPrefix = 'Token';

let apiInstance = new EquiblesStocks.StocksApi();
let fullTicker = "fullTicker_example"; // String | The fully qualified ticker of the stock. Example: AAPL.XNAS
let opts = { 
  'page': 1, // Number | The number of the page to request.
  'pageSize': 1000 // Number | The number of elements in each page. Max value: 1000.
};
apiInstance.splits(fullTicker, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
fullTicker String The fully qualified ticker of the stock. Example: AAPL.XNAS
page Number The number of the page to request. [optional] [default to 1]
pageSize Number The number of elements in each page. Max value: 1000. [optional] [default to 1000]

Return type

SplitsResponse

Authorization

[Query String](../README.md#Query String)

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json