Skip to content

Latest commit

 

History

History
180 lines (126 loc) · 9.68 KB

CurrencyApi.md

File metadata and controls

180 lines (126 loc) · 9.68 KB
Raw

data_bridges_client.CurrencyApi

All URIs are relative to https://api.wfp.org/vam-data-bridges/5.0.0

Method HTTP request Description
currency_list_get GET /Currency/List Returns the list of currencies available in the internal VAM database, with Currency 3-letter code, matching with ISO 4217.
currency_usd_indirect_quotation_get GET /Currency/UsdIndirectQuotation Returns the value of the Exchange rates from Trading Economics, for official rates, and DataViz for unofficial rates.

currency_list_get

PagedCurrencyListDTO currency_list_get(country_code=country_code, currency_name=currency_name, currency_id=currency_id, page=page, format=format, env=env)

Returns the list of currencies available in the internal VAM database, with Currency 3-letter code, matching with ISO 4217.

Generic badge Generic badge Generic badge ### This endpoint is restricted, it requires the scope: "vamdatabridges_currency-list_get" Data Controller - Wael ATTIA API Integration Pattern - This endpoint uses Hey Jude pattern

Example

  • OAuth Authentication (default):
import data_bridges_client
from data_bridges_client.models.paged_currency_list_dto import PagedCurrencyListDTO
from data_bridges_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = data_bridges_client.Configuration(
    host = "https://api.wfp.org/vam-data-bridges/5.0.0"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with data_bridges_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = data_bridges_client.CurrencyApi(api_client)
    country_code = 'country_code_example' # str | The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code. (optional)
    currency_name = 'currency_name_example' # str | Currency 3-letter code, matching with ISO 4217. (optional)
    currency_id = 0 # int | Unique code to identify the currency in internal VAM currencies. (optional) (default to 0)
    page = 1 # int | Page number for paged results (optional) (default to 1)
    format = 'json' # str | Output format: [JSON|CSV] Json is the default value (optional) (default to 'json')
    env = 'env_example' # str | Environment.   * `prod` - api.vam.wfp.org   * `dev` - dev.api.vam.wfp.org (optional)

    try:
        # Returns the list of currencies available in the internal VAM database, with Currency 3-letter code, matching with ISO 4217.
        api_response = api_instance.currency_list_get(country_code=country_code, currency_name=currency_name, currency_id=currency_id, page=page, format=format, env=env)
        print("The response of CurrencyApi->currency_list_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CurrencyApi->currency_list_get: %s\n" % e)

Parameters

Name Type Description Notes
country_code str The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code. [optional]
currency_name str Currency 3-letter code, matching with ISO 4217. [optional]
currency_id int Unique code to identify the currency in internal VAM currencies. [optional] [default to 0]
page int Page number for paged results [optional] [default to 1]
format str Output format: [JSON CSV] Json is the default value
env str Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org [optional]

Return type

PagedCurrencyListDTO

Authorization

default

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -

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

currency_usd_indirect_quotation_get

UsdIndirectQuotationPagedResult currency_usd_indirect_quotation_get(country_iso3=country_iso3, currency_name=currency_name, page=page, format=format, env=env)

Returns the value of the Exchange rates from Trading Economics, for official rates, and DataViz for unofficial rates.

Generic badge Generic badge Generic badge ### This endpoint is restricted, it requires the scope: "vamdatabridges_currency-usdindirectquotation_get" Returns the time series of values of the Exchange rate of the Local Currency for buying 1 USD in the official market. Original frequency for official rates is daily, non-indicated. Unofficial rates are aggregated at national level by the original frequency of collection. For greater detail on unofficial exchange rates, explore the Exchange Rate (unofficial) commodity in Market Prices Prices. No mandatory parameter. Data Controller - Wael ATTIA API Integration Pattern - This endpoint uses Hey Jude pattern

Example

  • OAuth Authentication (default):
import data_bridges_client
from data_bridges_client.models.usd_indirect_quotation_paged_result import UsdIndirectQuotationPagedResult
from data_bridges_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = data_bridges_client.Configuration(
    host = "https://api.wfp.org/vam-data-bridges/5.0.0"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with data_bridges_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = data_bridges_client.CurrencyApi(api_client)
    country_iso3 = '' # str | The code to identify the country. Must be a ISO-3166 Alpha 3 code. (optional) (default to '')
    currency_name = '' # str | the ISO3 code for the currency, based on ISO4217 (optional) (default to '')
    page = 1 # int | Page number for paged results (optional) (default to 1)
    format = 'json' # str | Output format: [JSON|CSV] Json is the default value (optional) (default to 'json')
    env = 'env_example' # str | Environment.   * `prod` - api.vam.wfp.org   * `dev` - dev.api.vam.wfp.org (optional)

    try:
        # Returns the value of the Exchange rates from Trading Economics, for official rates, and DataViz for unofficial rates.
        api_response = api_instance.currency_usd_indirect_quotation_get(country_iso3=country_iso3, currency_name=currency_name, page=page, format=format, env=env)
        print("The response of CurrencyApi->currency_usd_indirect_quotation_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CurrencyApi->currency_usd_indirect_quotation_get: %s\n" % e)

Parameters

Name Type Description Notes
country_iso3 str The code to identify the country. Must be a ISO-3166 Alpha 3 code. [optional] [default to '']
currency_name str the ISO3 code for the currency, based on ISO4217 [optional] [default to '']
page int Page number for paged results [optional] [default to 1]
format str Output format: [JSON CSV] Json is the default value
env str Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org [optional]

Return type

UsdIndirectQuotationPagedResult

Authorization

default

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -

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