@factset/sdk-factsettickhistory
v0.33.0
Published
FactSet Tick History client library for JavaScript
Downloads
130
Readme
FactSet Tick History client library for JavaScript
Tick History provides dynamic access to historical tick data for a specific security for specific dates or date range.
This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:
- API version: 2.3.0
- SDK version: 0.33.0
- Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen
For more information, please visit https://developer.factset.com/contact
Requirements
- Node.js >= 18
Installation
npm
npm install @factset/sdk-utils @factset/[email protected]
yarn
yarn add @factset/sdk-utils @factset/[email protected]
Usage
- Generate authentication credentials.
- Setup Node.js environment
Install and activate Node.js >=18. If you're using nvm:
nvm install 18 nvm use 18
(optional) Install yarn.
- Install dependencies.
- Run the following:
[!IMPORTANT] The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.
Example Code
const { ApiClient, Level1Api } = require('@factset/sdk-factsettickhistory');
const { ConfidentialClient } = require('@factset/sdk-utils');
const apiClient = ApiClient.instance;
// Examples for each supported authentication method are below,
// choose one that satisfies your use case.
// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');
// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';
const apiInstance = new Level1Api();
const id = "id_example"; // String | id returned by files create endpoint to poll and collect status of the query
// Call api endpoint
apiInstance.getLevel1FileStatus(id).then(
data => {
// data is a responsewrapper: GetLevel1FileStatusResponseWrapper
switch (data.statusCode) {
case 201:
// CompletedResponse
console.log(data.getResponse201());
break;
case 202:
// SubmittedResponse
console.log(data.getResponse202());
break;
}
},
error => {
console.error(error);
},
);
Using a Proxy
To add a HTTP proxy for the API client, you can set the proxyUrl for the ApiClient instance:
const { ApiClient } = require('@factset/sdk-factsettickhistory');
const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:[email protected]:8080');
Documentation for API Endpoints
All URIs are relative to https://api.factset.com/tick-history/v2
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- factsettickhistory.Level1Api | getLevel1FileStatus | GET /level1/files/status | Returns the status of the ID factsettickhistory.Level1Api | getMinutebarsFileStatus | GET /level1/files/minute-bars/status | Returns the status of the ID factsettickhistory.Level1Api | getMinutebarsFiles | GET /level1/files/minute-bars/get | Returns the Minute bars data in files requested in the /create endpoint factsettickhistory.Level1Api | getTickHistoryLevel1Files | GET /level1/files/get | Returns the tick-by-tick data in files requested in the /create endpoint factsettickhistory.Level1Api | requestMinutebarsFiles | POST /level1/files/minute-bars/create | Requests the creation of Minute bars file factsettickhistory.Level1Api | requestTickHistoryCoverage | GET /level1/coverage | Returns the coverage for the requested ticker/isin along with other response fields for Level1 data. factsettickhistory.Level1Api | requestTickHistoryLevel1Files | POST /level1/files/create | Requests the creation of tick-by-tick file
Documentation for Models
- factsettickhistory.CheckFiles
- factsettickhistory.CompletedResponse
- factsettickhistory.CoverageResponse
- factsettickhistory.CoverageTickHistory
- factsettickhistory.DateTimePeriod
- factsettickhistory.DateTimePeriodMin
- factsettickhistory.ErrorExample
- factsettickhistory.ErrorObject
- factsettickhistory.Files
- factsettickhistory.FilesOne
- factsettickhistory.GetFilesMinuteResponse
- factsettickhistory.GetFilesResponse
- factsettickhistory.Granularity
- factsettickhistory.Level1RequestBody
- factsettickhistory.LeveloneRequest
- factsettickhistory.Meta
- factsettickhistory.MinRequest
- factsettickhistory.MinTickData
- factsettickhistory.MinutesbarRequestBody
- factsettickhistory.Pagination
- factsettickhistory.Status
- factsettickhistory.StatusOne
- factsettickhistory.SubmittedResponse
- factsettickhistory.TickData
- factsettickhistory.Type
Documentation for Authorization
FactSetApiKey
- Type: HTTP basic authentication
FactSetOAuth2
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes: N/A
Contributing
Please refer to the contributing guide.
Copyright
Copyright 2022 FactSet Research Systems Inc
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.