110 lines
3.3 KiB
Markdown
110 lines
3.3 KiB
Markdown
# fintracker_api.api.InstrumentsApi
|
|
|
|
## Load the API package
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
```
|
|
|
|
All URIs are relative to *http://localhost*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**instrumentsGet**](InstrumentsApi.md#instrumentsget) | **GET** /api/v1/instruments/{instrument_id} | Get
|
|
[**instrumentsList**](InstrumentsApi.md#instrumentslist) | **GET** /api/v1/instruments | List
|
|
|
|
|
|
# **instrumentsGet**
|
|
> InstrumentDetail instrumentsGet(instrumentId, scope, pricesFrom)
|
|
|
|
Get
|
|
|
|
One instrument with its position, open lots, events and price history.
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
|
|
final api = FintrackerApi().getInstrumentsApi();
|
|
final int instrumentId = 56; // int |
|
|
final String scope = scope_example; // String | all | account:<id> | portfolio:<id>
|
|
final DateTime pricesFrom = 2013-10-20; // DateTime |
|
|
|
|
try {
|
|
final response = api.instrumentsGet(instrumentId, scope, pricesFrom);
|
|
print(response);
|
|
} on DioException catch (e) {
|
|
print('Exception when calling InstrumentsApi->instrumentsGet: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**instrumentId** | **int**| |
|
|
**scope** | **String**| all | account:<id> | portfolio:<id> | [optional] [default to 'all']
|
|
**pricesFrom** | **DateTime**| | [optional]
|
|
|
|
### Return type
|
|
|
|
[**InstrumentDetail**](InstrumentDetail.md)
|
|
|
|
### Authorization
|
|
|
|
[HTTPBearer](../README.md#HTTPBearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json, application/problem+json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **instrumentsList**
|
|
> List<InstrumentOut> instrumentsList(q, assetClass, heldOnly, limit)
|
|
|
|
List
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
|
|
final api = FintrackerApi().getInstrumentsApi();
|
|
final String q = q_example; // String | substring of ticker, name or ISIN
|
|
final String assetClass = assetClass_example; // String | share | bond | etf | fund | currency | index | …
|
|
final bool heldOnly = true; // bool | only instruments with an open lot
|
|
final int limit = 56; // int |
|
|
|
|
try {
|
|
final response = api.instrumentsList(q, assetClass, heldOnly, limit);
|
|
print(response);
|
|
} on DioException catch (e) {
|
|
print('Exception when calling InstrumentsApi->instrumentsList: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**q** | **String**| substring of ticker, name or ISIN | [optional]
|
|
**assetClass** | **String**| share | bond | etf | fund | currency | index | … | [optional]
|
|
**heldOnly** | **bool**| only instruments with an open lot | [optional] [default to false]
|
|
**limit** | **int**| | [optional] [default to 100]
|
|
|
|
### Return type
|
|
|
|
[**List<InstrumentOut>**](InstrumentOut.md)
|
|
|
|
### Authorization
|
|
|
|
[HTTPBearer](../README.md#HTTPBearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json, application/problem+json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|