chore(app): сгенерированный Dart-клиент с методами аналитики
just gen-client после новых роутов.
This commit is contained in:
Dmitry
@@ -0,0 +1,19 @@
|
||||
# fintracker_api.model.AllocationBucket
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**bucket** | **String** | |
|
||||
**dimension** | [**AllocationDimension**](AllocationDimension.md) | |
|
||||
**holdingCount** | **int** | |
|
||||
**valueRub** | **String** | decimal as string |
|
||||
**weight** | **String** | decimal as string |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# fintracker_api.model.AllocationDimension
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,279 @@
|
||||
# fintracker_api.api.AnalyticsApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**analyticsAllocation**](AnalyticsApi.md#analyticsallocation) | **GET** /api/v1/analytics/allocation | Allocation
|
||||
[**analyticsHoldings**](AnalyticsApi.md#analyticsholdings) | **GET** /api/v1/analytics/holdings | Holdings
|
||||
[**analyticsReturns**](AnalyticsApi.md#analyticsreturns) | **GET** /api/v1/analytics/returns | Returns
|
||||
[**analyticsScopes**](AnalyticsApi.md#analyticsscopes) | **GET** /api/v1/analytics/scopes | Scopes
|
||||
[**analyticsSummary**](AnalyticsApi.md#analyticssummary) | **GET** /api/v1/analytics/summary | Summary
|
||||
[**analyticsValueSeries**](AnalyticsApi.md#analyticsvalueseries) | **GET** /api/v1/analytics/value-series | Value Series
|
||||
|
||||
|
||||
# **analyticsAllocation**
|
||||
> List<AllocationBucket> analyticsAllocation(scope, dimension)
|
||||
|
||||
Allocation
|
||||
|
||||
Buckets of one dimension (or all four), largest first.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getAnalyticsApi();
|
||||
final String scope = scope_example; // String | all | account:<id> | portfolio:<id>
|
||||
final AllocationDimension dimension = ; // AllocationDimension |
|
||||
|
||||
try {
|
||||
final response = api.analyticsAllocation(scope, dimension);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling AnalyticsApi->analyticsAllocation: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**scope** | **String**| all | account:<id> | portfolio:<id> | [optional] [default to 'all']
|
||||
**dimension** | [**AllocationDimension**](.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<AllocationBucket>**](AllocationBucket.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)
|
||||
|
||||
# **analyticsHoldings**
|
||||
> List<HoldingOut> analyticsHoldings(scope)
|
||||
|
||||
Holdings
|
||||
|
||||
Open positions, most valuable first; unpriced ones last with null values.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getAnalyticsApi();
|
||||
final String scope = scope_example; // String | all | account:<id> | portfolio:<id>
|
||||
|
||||
try {
|
||||
final response = api.analyticsHoldings(scope);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling AnalyticsApi->analyticsHoldings: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**scope** | **String**| all | account:<id> | portfolio:<id> | [optional] [default to 'all']
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<HoldingOut>**](HoldingOut.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)
|
||||
|
||||
# **analyticsReturns**
|
||||
> List<ReturnsOut> analyticsReturns(scope)
|
||||
|
||||
Returns
|
||||
|
||||
XIRR and TWR per period, shortest first.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getAnalyticsApi();
|
||||
final String scope = scope_example; // String | all | account:<id> | portfolio:<id>
|
||||
|
||||
try {
|
||||
final response = api.analyticsReturns(scope);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling AnalyticsApi->analyticsReturns: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**scope** | **String**| all | account:<id> | portfolio:<id> | [optional] [default to 'all']
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<ReturnsOut>**](ReturnsOut.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)
|
||||
|
||||
# **analyticsScopes**
|
||||
> List<ScopeOut> analyticsScopes()
|
||||
|
||||
Scopes
|
||||
|
||||
Every set of accounts the metrics were built for.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getAnalyticsApi();
|
||||
|
||||
try {
|
||||
final response = api.analyticsScopes();
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling AnalyticsApi->analyticsScopes: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<ScopeOut>**](ScopeOut.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)
|
||||
|
||||
# **analyticsSummary**
|
||||
> SummaryOut analyticsSummary(scope)
|
||||
|
||||
Summary
|
||||
|
||||
One screen's worth: the latest day, the totals it adds up to, and the returns.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getAnalyticsApi();
|
||||
final String scope = scope_example; // String | all | account:<id> | portfolio:<id>
|
||||
|
||||
try {
|
||||
final response = api.analyticsSummary(scope);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling AnalyticsApi->analyticsSummary: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**scope** | **String**| all | account:<id> | portfolio:<id> | [optional] [default to 'all']
|
||||
|
||||
### Return type
|
||||
|
||||
[**SummaryOut**](SummaryOut.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)
|
||||
|
||||
# **analyticsValueSeries**
|
||||
> List<ValueDay> analyticsValueSeries(scope, from, to)
|
||||
|
||||
Value Series
|
||||
|
||||
Daily portfolio value; defaults to the last 365 days.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getAnalyticsApi();
|
||||
final String scope = scope_example; // String | all | account:<id> | portfolio:<id>
|
||||
final DateTime from = 2013-10-20; // DateTime |
|
||||
final DateTime to = 2013-10-20; // DateTime |
|
||||
|
||||
try {
|
||||
final response = api.analyticsValueSeries(scope, from, to);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling AnalyticsApi->analyticsValueSeries: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**scope** | **String**| all | account:<id> | portfolio:<id> | [optional] [default to 'all']
|
||||
**from** | **DateTime**| | [optional]
|
||||
**to** | **DateTime**| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<ValueDay>**](ValueDay.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)
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# fintracker_api.model.EventKind
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
# fintracker_api.model.EventOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accountId** | **int** | |
|
||||
**accruedInterest** | **String** | decimal as string |
|
||||
**amount** | **String** | decimal as string |
|
||||
**amountRub** | **String** | decimal as string |
|
||||
**currency** | **String** | |
|
||||
**description** | **String** | |
|
||||
**externalFlow** | **bool** | |
|
||||
**fee** | **String** | decimal as string |
|
||||
**id** | **int** | |
|
||||
**instrumentId** | **int** | |
|
||||
**kind** | [**EventKind**](EventKind.md) | |
|
||||
**price** | **String** | decimal as string |
|
||||
**priceCurrency** | **String** | |
|
||||
**quantity** | **String** | decimal as string |
|
||||
**status** | [**EventStatus**](EventStatus.md) | |
|
||||
**tax** | **String** | decimal as string |
|
||||
**ticker** | **String** | |
|
||||
**tradeDate** | [**DateTime**](DateTime.md) | |
|
||||
**ts** | [**DateTime**](DateTime.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# fintracker_api.model.EventPage
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**items** | [**List<EventOut>**](EventOut.md) | |
|
||||
**page** | **int** | |
|
||||
**pageSize** | **int** | |
|
||||
**total** | **int** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# fintracker_api.model.EventStatus
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,75 @@
|
||||
# fintracker_api.api.EventsApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**eventsList**](EventsApi.md#eventslist) | **GET** /api/v1/events | List
|
||||
|
||||
|
||||
# **eventsList**
|
||||
> EventPage eventsList(from, to, accountId, instrumentId, kind, status, externalFlow, q, page, pageSize)
|
||||
|
||||
List
|
||||
|
||||
One page of ledger events, newest first, with RUB amounts at each own date's rate.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getEventsApi();
|
||||
final DateTime from = 2013-10-20; // DateTime |
|
||||
final DateTime to = 2013-10-20; // DateTime |
|
||||
final int accountId = 56; // int |
|
||||
final int instrumentId = 56; // int |
|
||||
final EventKind kind = ; // EventKind |
|
||||
final EventStatus status = ; // EventStatus |
|
||||
final bool externalFlow = true; // bool | only the events XIRR reads as boundary flows
|
||||
final String q = q_example; // String | substring of description or ticker
|
||||
final int page = 56; // int |
|
||||
final int pageSize = 56; // int |
|
||||
|
||||
try {
|
||||
final response = api.eventsList(from, to, accountId, instrumentId, kind, status, externalFlow, q, page, pageSize);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling EventsApi->eventsList: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**from** | **DateTime**| | [optional]
|
||||
**to** | **DateTime**| | [optional]
|
||||
**accountId** | **int**| | [optional]
|
||||
**instrumentId** | **int**| | [optional]
|
||||
**kind** | [**EventKind**](.md)| | [optional]
|
||||
**status** | [**EventStatus**](.md)| | [optional]
|
||||
**externalFlow** | **bool**| only the events XIRR reads as boundary flows | [optional]
|
||||
**q** | **String**| substring of description or ticker | [optional]
|
||||
**page** | **int**| | [optional] [default to 1]
|
||||
**pageSize** | **int**| | [optional] [default to 50]
|
||||
|
||||
### Return type
|
||||
|
||||
[**EventPage**](EventPage.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)
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# fintracker_api.model.HoldingOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accruedInterestRub** | **String** | decimal as string |
|
||||
**assetClass** | **String** | |
|
||||
**avgCost** | **String** | decimal as string |
|
||||
**board** | **String** | |
|
||||
**costCurrency** | **String** | |
|
||||
**costTotalRub** | **String** | decimal as string |
|
||||
**currency** | **String** | |
|
||||
**daysHeld** | **int** | |
|
||||
**firstBuyDate** | [**DateTime**](DateTime.md) | |
|
||||
**incomeRub** | **String** | decimal as string |
|
||||
**instrumentId** | **int** | |
|
||||
**ldvEligibleQty** | **String** | decimal as string |
|
||||
**marketPrice** | **String** | decimal as string |
|
||||
**name** | **String** | |
|
||||
**priceCurrency** | **String** | |
|
||||
**priceDate** | [**DateTime**](DateTime.md) | |
|
||||
**priceStatus** | **String** | |
|
||||
**qty** | **String** | decimal as string |
|
||||
**realizedPnlRub** | **String** | decimal as string |
|
||||
**ticker** | **String** | |
|
||||
**unrealizedPnlNative** | **String** | decimal as string |
|
||||
**unrealizedPnlRub** | **String** | decimal as string |
|
||||
**valueNative** | **String** | decimal as string |
|
||||
**valueRub** | **String** | decimal as string |
|
||||
**weight** | **String** | decimal as string |
|
||||
**xirr** | **String** | decimal as string |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
# fintracker_api.model.InstrumentDetail
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**events** | [**List<EventOut>**](EventOut.md) | |
|
||||
**holding** | [**HoldingOut**](HoldingOut.md) | |
|
||||
**instrument** | [**InstrumentOut**](InstrumentOut.md) | |
|
||||
**lots** | [**List<LotOut>**](LotOut.md) | |
|
||||
**prices** | [**List<PricePoint>**](PricePoint.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
# fintracker_api.model.InstrumentOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**assetClass** | **String** | |
|
||||
**board** | **String** | |
|
||||
**country** | **String** | |
|
||||
**currency** | **String** | |
|
||||
**exchange** | **String** | |
|
||||
**figi** | **String** | |
|
||||
**id** | **int** | |
|
||||
**isActive** | **bool** | |
|
||||
**isin** | **String** | |
|
||||
**issuer** | **String** | |
|
||||
**lot** | **int** | |
|
||||
**maturityDate** | [**DateTime**](DateTime.md) | |
|
||||
**name** | **String** | |
|
||||
**nominal** | **String** | decimal as string |
|
||||
**nominalCurrency** | **String** | |
|
||||
**sector** | **String** | |
|
||||
**ticker** | **String** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,109 @@
|
||||
# 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)
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# fintracker_api.model.LotOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accountId** | **int** | |
|
||||
**closedAt** | [**DateTime**](DateTime.md) | |
|
||||
**costCurrency** | **String** | |
|
||||
**costPerUnit** | **String** | decimal as string |
|
||||
**costTotalRub** | **String** | decimal as string |
|
||||
**id** | **int** | |
|
||||
**openDate** | [**DateTime**](DateTime.md) | |
|
||||
**qtyOpen** | **String** | decimal as string |
|
||||
**qtyRemaining** | **String** | decimal as string |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# fintracker_api.model.PricePoint
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accruedInterest** | **String** | decimal as string |
|
||||
**close** | **String** | decimal as string |
|
||||
**currency** | **String** | |
|
||||
**d** | [**DateTime**](DateTime.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
# fintracker_api.model.ReturnsOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**absPnlRub** | **String** | decimal as string |
|
||||
**dateFrom** | [**DateTime**](DateTime.md) | |
|
||||
**dateTo** | [**DateTime**](DateTime.md) | |
|
||||
**externalFlowRub** | **String** | decimal as string |
|
||||
**period** | **String** | |
|
||||
**twr** | **String** | decimal as string |
|
||||
**twrAnnualized** | **String** | decimal as string |
|
||||
**twrDaysSkipped** | **int** | |
|
||||
**valueEndRub** | **String** | decimal as string |
|
||||
**valueStartRub** | **String** | decimal as string |
|
||||
**xirr** | **String** | decimal as string |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
# fintracker_api.model.ScopeOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accountIds** | **List<int>** | |
|
||||
**name** | **String** | |
|
||||
**scope** | **String** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
# fintracker_api.model.SummaryOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**asOf** | [**DateTime**](DateTime.md) | |
|
||||
**cashRub** | **String** | decimal as string |
|
||||
**computedAt** | [**DateTime**](DateTime.md) | |
|
||||
**holdingCount** | **int** | |
|
||||
**incomeRub** | **String** | decimal as string |
|
||||
**investedNetRub** | **String** | decimal as string |
|
||||
**marketValueRub** | **String** | decimal as string |
|
||||
**pnlTotalRub** | **String** | decimal as string |
|
||||
**realizedPnlRub** | **String** | decimal as string |
|
||||
**returns** | [**List<ReturnsOut>**](ReturnsOut.md) | |
|
||||
**scope** | **String** | |
|
||||
**staleCount** | **int** | |
|
||||
**totalRub** | **String** | decimal as string |
|
||||
**unpricedCount** | **int** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
# fintracker_api.model.ValueDay
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accruedInterestRub** | **String** | decimal as string |
|
||||
**cashRub** | **String** | decimal as string |
|
||||
**d** | [**DateTime**](DateTime.md) | |
|
||||
**externalFlowRub** | **String** | decimal as string |
|
||||
**investedNetRub** | **String** | decimal as string |
|
||||
**marketValueRub** | **String** | decimal as string |
|
||||
**missingFxCount** | **int** | |
|
||||
**missingPriceCount** | **int** | |
|
||||
**pnlTotalRub** | **String** | decimal as string |
|
||||
**stalePriceCount** | **int** | |
|
||||
**totalRub** | **String** | decimal as string |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user