Available translations
loading results
API Path Parameters
API Path Parameters are embedded as part of an URL path. They allow you to specify the unique path to your endpoint.
How to identify API Path Parameters
The API you are trying to map should have it's API Path Parameters documented. If not, check any examples they may provide for how to request the data and see if there are inner folders below the main folder of the API Enpoint. Each one of these folders are an API Path Parameter that needs to be defined.
Tip: As with everything else in Superalgos, node children are considered clockwise. This is important because it will affect the order in which Superalgos builds the URL request you will send to the API.
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 Path Parameters Menu
The API Path Parameters node has the following Node Menu items:
The Add API Path Parameter menu item has the following properties:
- action: Add UI Object
- label: Add API Path Parameter
- relatedUiObject: API Path Parameter
- 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 Path Parameters already has the required child type that the menu item may add, and only that child is allowed for that case.
API Path Parameters Children
The API Path Parameters node has the following childrenNodesProperties:
The Api Path Parameters node property features the following properties:
- name:
apiPathParameters
- type: array
- childType: API Path Parameter
- autoAdd: true
API Path Parameters Attaching Rules
The following are the Node Attaching Rules that govern the attachment of API Path Parameters with other nodes:
Compatible Types: