Available translations
loading results
API Version
An API might have different versions. This node is used for specifying the version that it's children are defining. At the codeName property we expect the version string that will be needed in the URL when calling the API Server.
Note: We expect every API to have at least one version. Others may have three or more.
Foundations->Topic->Data Mining - Fetching Data From APIs->Main Workflow
How to Fetch Data from an API?
The main workflow to pull this off is quite straight forward. It does not require coding at all. Follow this guide and you will be using data from any source on the Internet for your trading strategies in no time.
- 2. Design an API Map: Read the APIs online documentation and identify the Endpoints that return the data you would like to fetch. Carefully map the Endpoints defining the parameters the API Server expects at each call, and also how the API Server response is formatted.
- 3. Setup an API Data Fetcher Bot: Create a Data Mine for this API and add an API Data Fetcher Bot. From that Bot's Record Properties you will need to reference the fields returned by the API Server defined at the API Map. This is how you define which fields from each response you are going to save to disk. You might also need to define query or path parameters here.
- 4. Setup an Indicator Bot for Dataset Type Conversion: The Raw Data saved to disk needs to be organized for consumption. You will need to setup an Indicator Bot that will do a Dataset Type Conversion from Raw Data to a standard Dataset Type. This process will do data aggregation in order to generate the elements with a fixed time range for every Time Frame possible.
- 5. Setup Indicator Bots: Once the data is converted, you can extract specific Datasets from it. These datasets can be used to define a set of indicators you can build from that data. These Indicators can be as simple as reorganizations of the data (with some adjustments to the names of fields and splitting the data into different indicators), or it can include some data processing / transformations if you wish (this would require some coding).
- 6. Setup Plotters: After you have set up your indicators you can design plotters for them if you wish.
- 7. Use Data for Trading Strategies: These indicators can be consumed from your trading strategies.
Tip: There is a Workspace called API Data Fetcher Bot Demo with a simple working example of the previous steps you can use as a reference.
API Version Configuration
Properties
- codeName: Define the version of the API this branch of the map will handle.
Initial Values
These are the Initial Values for API Version configuration:
{
"codeName": ""
} Examples
This is a list of properties featured by the API Version configuration. Expanding a property shows sample values for the property extracted from the current Workspace.
API Version Menu
The API Version node has the following Node Menu items:
The Configure menu item has the following properties:
- action: Configure
- actionFunction:
uiObject.configEditor.activate
- label: Configure
- iconPathOn: configuration
- iconPathOff: configuration
The Add API Endpoint menu item has the following properties:
- action: Add UI Object
- label: Add API Endpoint
- relatedUiObject: API Endpoint
- actionFunction:
payload.executeAction
- actionProject: Visual-Scripting
- relatedUiObjectProject: Foundations
The Delete menu item has the following properties:
- action: Delete UI Object
- actionProject: Visual-Scripting
- askConfirmation: true
- confirmationLabel: Confirm to Delete
- label: Delete
- iconPathOn: delete-entity
- iconPathOff: delete-entity
- actionFunction:
payload.executeAction
Tip: When a menu item is grayed out, it means that API Version already has the required child type that the menu item may add, and only that child is allowed for that case.
API Version Children
The API Version node has the following childrenNodesProperties:
The Api Endpoints node property features the following properties:
- name:
apiEndpoints
- type: array
- childType: API Endpoint
- autoAdd: true
API Version Attaching Rules
The following are the Node Attaching Rules that govern the attachment of API Version with other nodes:
Compatible Types: