AppointmentTrader API Documentation
Welcome to the first version of AppointmentTrader API.
Great to see you are starting to use it!
To keep things simple, the API is designed for you to be able to request any endpoint with a HTTPS GET or POST call, whether the endpoint will write or read data.
In some edge cases you might need a POST request to transmit more data - more than likely you won't need that, but should you use a POST request, know that every parameter passed in via POST is prioritized over a passed GET parameter.
All values will be returned as a json encoded object.
Every response is structured as follows:
RequestStatus: "Succeeded" or "Failed"
ResponseCode: 100-100,000 (for success codes) 399-500,000 (for failure codes)
ResponseMessage: Details on what went right or wrong.
Only If the request succceeded there will the following parameter:
Payload: Data will be structure as indicated in the 'return' section of each endpoint description.
/v1/account/
Manages Access to the AppointmentTrader Account
get_list
Returns all available user accounts including their balances and if applicable credit limits in the smallest possible currency unit
/v1/location/
Handles all location related functions.
get_category
Returns the locations category type (f.i. Restaurant or Prepaid-Restaurant) and the required field list for listings of this category.
get_comparable_trades
Returns comparable price information for any inventory type and date.
get_inventory_types
Returns the inventory types available for the requested location.
get_metric_history
Returns history of location metrics across a defined timeframe
get_metrics
Returns detailed 90 day location trading metrics
set_listing
Submits a new listing for review or if the user has the Permission::SelfReviewListings the listing will be approved.
If the timeframe and price matches a vacant bid, the bid will be filled automatically.
Please keep in mind that account limits apply as posted in the permission overview of your account.
Note: This function currently only supports single timeslot listings, support for multiday listings such as hotel listings will follow.
Support for virtual phone, email and card numbers will also follow in a future release.
set_subscribe_to_city_area_priority_bids
Subscribe to Concierge Bids for the Area
You will receive a message each time when a bid is placed in the region.
set_subscribe_to_location_priority_bids
Subscribe to Insider Bids
You will receive a message each time when a bid is placed for this location.
set_unlock_exact_listing_times
Unlock Exact Listing Times
You will be able to see all exact listing start times for this day after unlocking.
set_unsubscribe_from_city_area_priority_bids
Unsubscribe from Concierge Bids for the Area
You will no longer receive a message each time when a bid is placed in the region.
set_unsubscribe_from_location_priority_bids
Unsubscribe from Insider Bids
You will no longer receive a message each time when a bid is placed for this location.
/v1/listing/
Manages portfolio related functions such as price changes and status changes
get_competing_listings
Lists competing listings in a certain timeframe, along with pricing information
get_portfolio_listings
Returns all listings in the users portfolio.
set_archive
Archive Listing
set_cancel_bid
Cancels a bid
set_create_from_template
Creates an appointment from a template,
only appointments owned by api user may be copied.
set_fill_bid
Fills a bid with a portfolio listing that is either off market or publicly available
to fill a bid with a new listing please use /v1/location/set_listing
set_market_visibility
Changes the visibility in the market.
In the portal private listings appear in the private section and public in 'Publicly traded listings'
set_price
Changes the current listing price
/v1/portfolio/
Manages all portfolio related functions
get_valid_location_identifiers
Searches available location identifiers for purposes of creating a buy order
set_bid
Create a Buy Order
The algorithm will place bids automatically pricing will be decided on a bid-per-bid basis but will never exceed or subsceed the minium bid price.
/v1/bid/
Manages all bid related functions
get_list
Returns all available bids with a reporting delay of 5 minutes.
/v1/marketdata/
Contains all market data related functions to allow sellers to pick up on trends throughout the year
get_highest_converting_locations
Returns the best converting venues, indicating the most demand for listings
get_most_bids_least_asks
Returns locations with the highest bids vs listing ratio
get_most_underserved_locations
Returns locations with the most bids and the least number of listings in the past 30 days
get_most_viewed_locations_with_least_listings
Returns the most viewed locations with the least amount of listings
get_toplist
Returns locations with the most bids and the least number of listings in the past 30 days
/v1/medal/
Manages All Medal and User Permission Related Functions
get_achievement_bonus_types
Searches all available requirements
get_available_medal_categories
Searches all available medal categories on the platform
get_available_medals
Searches all available medals on the platform
get_available_permissions
Searches all available requirements
get_available_requirements
Searches all available requirements
set_achievement_bonus
Create a bonus for the Medal
The bonus defined below will be granted to people who achieve the Medal for the first time.
set_create_medal
Create A New Medal
Details can be edited using /v1/medal/set_edit_medal
set_delete_achievement_bonus
Delete the Achievement Bonus
Removes the achievement bonus linked to the medal.
set_edit_medal
Edit Medal
set_link_permission
Link a permission to the Medal
set_link_requirement
Link a requirement to the Medal
set_request_medal_sponsorship
Request Medal Sponsorship
will be asked to sponsor the medal defined below for you.
set_sponsor_user
Sponsor A Medal for
will be recommended for the medal you define below.
set_unlink_permission
Delete the Medal Permission link
Removes the linked permission.
set_unlink_requirement
Delete the Medal Requirement link
Removes the linked permission.
/v1/user/
Contains all user related functions
get
Searches all user aliasses
get_alternative_access_userlist
List of users who can access this account
get_transaction_history
Returns transaction history for the user
set_grant_access
Give another user access to this account
set_initiate_suspension
Initiates the user suspension process
set_referred_user
Link a user to be a referred
set_reinstate
Reinstate user privileges
/v1/notification/
Manages all notification related functions
set_readstate
Changes the visibility of the notifications in the ID list
In the portal private listings appear in the private section and public in 'Publicly traded listings'
/v1/tools/
Provides helpful functions to compliment appointment trades
get_convert_currency
Converts a currency amount
Attention: DO NOT USE for moneteray transactions, values are approximate!
get_geoip_data
Returns geolocation data from an ipaddress
/v1/community/
Manages Community Related Functions
set_create_poll_answer_for_question
Create a new answer option for the Question
set_create_poll_question_for_post
Create a new poll question for the Post
You will be able to add questions after completing this step.
set_submit_vote_for_question
Saves a poll answer
