Skip to content

TimeseriesAPI.md

Latest commit

 

History

History
147 lines (100 loc) · 3.88 KB

TimeseriesAPI.md

File metadata and controls

147 lines (100 loc) · 3.88 KB
Raw

TimeseriesAPI

All URIs are relative to https://finchapp.eastus.cloudapp.azure.com/api

Method HTTP request Description
getTimeseries GET /timeseries/{days} Get a user's projection timeseries
getTimeseriesExample GET /timeseries/example Get an example timeseries
getTimeseriesYear GET /timeseries Get timeseries with 365 future days generated

getTimeseries

    open class func getTimeseries(days: Double, completion: @escaping (_ data: TimeSeriesResponse?, _ error: Error?) -> Void)

Get a user's projection timeseries

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let days = 987 // Double | Number of days in the future to generate timeseries data for

// Get a user's projection timeseries
TimeseriesAPI.getTimeseries(days: days) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
days Double Number of days in the future to generate timeseries data for

Return type

TimeSeriesResponse

Authorization

sidCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTimeseriesExample

    open class func getTimeseriesExample(completion: @escaping (_ data: TimeSeriesResponse?, _ error: Error?) -> Void)

Get an example timeseries

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient


// Get an example timeseries
TimeseriesAPI.getTimeseriesExample() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

TimeSeriesResponse

Authorization

sidCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTimeseriesYear

    open class func getTimeseriesYear(completion: @escaping (_ data: TimeSeriesResponse?, _ error: Error?) -> Void)

Get timeseries with 365 future days generated

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient


// Get timeseries with 365 future days generated
TimeseriesAPI.getTimeseriesYear() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

TimeSeriesResponse

Authorization

sidCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]