tools API reference | AppointmentTrader

Search all endpoints

/v1/tools/

Provides helpful functions to compliment appointment trades

GET

/v1/tools/get_convert_currency

#

Converts a currency amount Attention: DO NOT USE for moneteray transactions, values are approximate!

Parameters

Name	Type	Required	Default	Description
`currencyAmountInSmallestPossibleUnit`	`int`	`Yes`	`—`	CurrencyAmount in smallest possible unit (for instance 25 EUR would be 2500)
`sourceCurrencyCode`	`string`	`Yes`	`—`
`destinationCurrencyCode`	`string`	`Yes`	`—`

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/tools/get_convert_currency' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'currencyAmountInSmallestPossibleUnit={{currencyAmountInSmallestPossibleUnit}}' \
  --data-urlencode 'sourceCurrencyCode={{sourceCurrencyCode}}' \
  --data-urlencode 'destinationCurrencyCode={{destinationCurrencyCode}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`tools_get_convert_currency_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`integer`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/tools/get_convert_currency",
    "RequestUserAlias": "example-user",
    "Payload": 0
}

Machine-readable endpoint documentation

GET

/v1/tools/get_geoip_data

#

Returns local GeoLite City data for an IPv4 or IPv6 address. Public-by-design: IP geolocation utility; it does not expose user account or session data.

Parameters

Name	Type	Required	Default	Description
`IPv4Address`	`string`	`Yes`	`—`	IPv4 or IPv6 address to locate; parameter name retained for compatibility.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/tools/get_geoip_data' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'IPv4Address={{IPv4Address}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required	Description
`$`	`tools_get_geoip_data_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ATResponseObjectType`	`= "NestedKeyValueList"`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.Name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.city`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.city.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.city.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.region_code`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.region_code.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.region_code.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.region_name`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.region_name.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.region_name.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.country_code`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.country_code.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.country_code.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.country_name`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.country_name.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.country_name.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.timezone`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.timezone.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.timezone.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.zip`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.zip.anyOf[0]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.zip.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.lat`	`DatabaseNumber`	`Yes`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.lat.oneOf[0]`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.lat.oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.long`		`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.long.anyOf[0]`	`DatabaseNumber`	`Yes`	Numeric value; MySQL reads can serialize numbers as numeric strings.
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.long.anyOf[0].oneOf[0]`	`number`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.long.anyOf[0].oneOf[1]`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.long.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.ip`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.agent`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.platform`	`= "n/a"`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList`	`= []`	`Yes`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList`	`= []`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/tools/get_geoip_data",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATResponseObjectType": "NestedKeyValueList",
        "ResponseBody": {
            "Name": "GeoIP Information for 192.0.2.10",
            "MetaInformation": {
                "lat": 0,
                "long": 0,
                "city": "Example City",
                "region_code": "EX",
                "region_name": "Example Region",
                "country_code": "EX",
                "country_name": "Example Country",
                "timezone": "Etc/UTC",
                "zip": "00000",
                "ip": "192.0.2.10",
                "agent": "Synthetic client",
                "platform": "n/a"
            },
            "KeyValueList": [],
            "KeyValueFieldList": []
        }
    }
}

Machine-readable endpoint documentation