API functions list

Alphabetical function list

The following functions are available in the API:

FunctionDescription
/account/balance Returns the current user balance.
/account/currency Returns the current user currency.
/account/id Returns the current user identifier.
/auction/bid/list Returns the list of bids in auction.
/auction/bid/list/count Returns the number of bids in auction.
/auction/bid/next Returns the minimal amount of next bid in auction.
/auction/get Returns information about auction.
/auction/list Returns the list of auctions listed in the marketplace. The marketplace is searched according to specified criteria. All criteria are optional and can be omitted.
/auction/list/count Returns the number of auctions listed on the marketplace and matching specified input criteria.
/buyer/auction/bid Places a bid in an auction.
/buyer/auction/list Returns the list of auctions where the user is bidding or watching.
/buyer/auction/list/count Returns the number of auctions where the user is bidding or watching.
/buyer/auction/lower Lower highest bid in auction.
/buyer/auction/maximum Returns the maximum user bid in a given auction.
/buyer/auction/note/get It gets private note for auction.
/buyer/auction/note/set It sets private note for auction.
/buyer/auction/past/list Returns the list of auctions where the user was bidding or watching.
/buyer/auction/past/list/count Returns the number of auctions where the user was bidding or watching.
/buyer/auction/unwatch Deletes an auction from list of watched auctions.
/buyer/auction/watch Adds an auction to list of watched auctions.
/buyer/auction/watch/list Returns the list of watched auctions.
/buyer/auction/watch/list/count Returns the number of list of watched auctions.
/buyer/catch/add Adds domain to catch.
/buyer/catch/list Returns the list of user domains to catch.
/buyer/catch/list/count Returns the number of user domains to catch.
/buyer/catch/note/get Returns note for a domain to catch or for already caught or not caught domain.
/buyer/catch/note/set Sets note for a domain to catch or for already caught or not caught domain.
/buyer/catch/option/add Adds option to catch.
/buyer/catch/option/list Returns the list of user options to catch.
/buyer/catch/option/list/count Returns the number of user options to catch.
/buyer/catch/option/note/get Returns note for a option to catch or for already caught or not caught option.
/buyer/catch/option/note/set Sets note for a option to catch or for already caught or not caught option.
/buyer/catch/option/remove Remove option from catch list (/buyer/catch/option/list).
/buyer/catch/remove Remove domain from catch list (/buyer/catch/list).
/buyer/catch/waiting/list Returns list of all not expiring domains which user wants to catch.
/buyer/catch/waiting/list/count Returns the number of all not expiring domains which user wants to catch.
/buyer/caught/list Returns list of domains caught for user.
/buyer/caught/list/count Returns the number of domains caught for user.
/buyer/caught/option/list Returns list of options caught for user.
/buyer/caught/option/list/count Returns the number of options caught for user.
/buyer/counteroffer/accept Accepts purchase counteroffer. An Escrow transaction for specified domain is started with the price indicated in the offer by the seller.
/buyer/counteroffer/get Returns information about a domain purchase counteroffer.
/buyer/counteroffer/list Returns the list of received counteroffers. The seller can propose a higher price to the buyer, and such proposition is called a counteroffer. Fuction retrieves counteroffer from seller to buyer (for buyer).
/buyer/counteroffer/list/count Returns the number of received counteroffers.
/buyer/counteroffer/past/list Returns the list of inactive received counteroffers.
/buyer/counteroffer/past/list/count Returns the number of inactive received counteroffers.
/buyer/counteroffer/reject Rejects a received counteroffer. The domain purchase offer is rejected and becomes inactive.
/buyer/escrow/accept Accept by buyer escrow transaction.
/buyer/escrow/list Returns the list of escrows, in which user buys domains.
/buyer/escrow/list/count Returns the number of escrows, in which user buys domains.
/buyer/escrow/note/get It gets private note for escrow.
/buyer/escrow/note/set It sets private note for escrow.
/buyer/escrow/reject Reject by buyer escrow transaction.
/buyer/expiring/domain/category/list It retrieves the list of expiring domains categories.
/buyer/expiring/domain/category/list/count It retrieves the number of expiring domains categories.
/buyer/expiring/domain/list Returns a list of expiring domains.
/buyer/expiring/domain/list/count Returns the number of expiring domains.
/buyer/expiring/option/list Returns a list of expiring options.
/buyer/expiring/option/list/count Returns the number of expiring options.
/buyer/hire/accept Accept by buyer hire transaction.
/buyer/hire/list Returns the list of hire transactions, in which user buys domains.
/buyer/hire/list/count Returns the number of hire transactions, in which user sells domains.
/buyer/hire/note/get It gets private note for hire.
/buyer/hire/note/set It sets private note for hire.
/buyer/hire/reject Reject by buyer hire transaction.
/buyer/listing/buy Purchases a domain for a Buy It Now price. The domain is purchased for a Buy It Now price indicated on the marketplace. An Escrow transaction is immediately started for the domain.
/buyer/listing/installment Buy a domain that is set for installment sale on marketplace.
/buyer/listing/rental Rent domain that is set for rental on marketplace.
/buyer/notcaught/list Returns list of domains not caught for user.
/buyer/notcaught/list/count Returns the number of domains not caught for user.
/buyer/notcaught/option/list Returns list of options not caught for user.
/buyer/notcaught/option/list/count Returns the number of options not caught for user.
/buyer/offer/add Makes a purchase offer for a domain on the marketplace. A binding purchase offer is entered for the specified domain, and the seller is notifed via email so that they can act on the offer.
/buyer/offer/cancel Cancel offer made by buyer.
/buyer/offer/get Returns information about a domain purchase offer.
/buyer/offer/list Returns the list of submitted offers. The list contains purchase offers that have been submitted by the user, for domains being sold by other users.
/buyer/offer/list/count Returns the number of submitted offers.
/buyer/offer/past/list Returns the list of inactive submitted offers.
/buyer/offer/past/list/count Returns the number of inactive submitted offers.
/buyer/rating It gets buyer rating information.
/buyer/rental/accept It accepts rental transaction.
/buyer/rental/buy It buys, by lessee, the domain during rental transaction.
/buyer/rental/finish It terminates, by lessee, rental transaction.
/buyer/rental/list It returns the list of rental transactions, in which user is a lessee.
/buyer/rental/list/count It returns the number of rental transactions, in which user is a lessee.
/buyer/rental/note/get It gets private note for rental.
/buyer/rental/note/set It sets private note for rental.
/buyer/rental/reject It rejects rental transaction.
/category/list It retrieves the list of marketplace categories.
/category/list/count It retrieves the number of marketplace categories.
/check/domain/contact/set/paid Cost of change domain profile contact.
/check/domain/reactivate Cost of reactivate expiring domain.
/check/domain/renew Cost of renew domain.
/check/future/renew Cost of renew future.
/check/order/prolong Prolong order.
/check/seller/auction/add Cost of add new auction.
/check/seller/auction/cancel Cost of auction cancel.
/check/seller/auction/endtime/prolong Cost of change auction end time.
/check/seller/auction/lastminute/add Cost of add new auction last minute.
/check/seller/auction/option/add Cost of add new future auction.
/check/seller/auction/price/set Cost of change auction prices.
/check/transfer/in/add Cost of domain transfer into your account.
/check/transfer/out/add Cost of outgoing transfer for domain to other account.
/contact/add Create domain registration contact profile.
/contact/default/get Get default user contact profile data.
/contact/default/set Set contact profile as default.
/contact/domain/list Returns the list of domain names assigned to contact profile.
/contact/domain/list/count Returns the number of domains assigned to contact profile.
/contact/get Returns contact profile data.
/contact/list Returns the list of user contact profiles.
/contact/list/count Returns the number of user contact profiles.
/contact/modify Modify domain registration contact profile data.
/contact/remove Remove specified contact profile.
/currency/exchange Converts amount from one currency to another.
/currency/list Retrieves list of available currency codes.
/domain/add Register domain.
/domain/authinfo Returns the AuthInfo code for specified domain.
/domain/autorenew/days/get Returns days before expires to start domain autorenewal.
/domain/autorenew/get Get automatic renew status for domain. If set and autorenewal is not globally blocked for account, then domain will be automatically renewed in proper time.
/domain/autorenew/set Set automatic renew for domain. If set, then member should not remember about expires time.
/domain/book Book domain.
/domain/check Check status for input domains for registration.
/domain/contact/get Returns contact profile id for domain.
/domain/contact/set Set contact profile for domain.
/domain/contact/set/paid Payable change domain profile contact. It's allow to change owner of domain, between member's defined contacts (/contact/list) Change owner on some domains is payable.
/domain/created Returns the creation time for specified domain.
/domain/dns/add Add new DNS entry for domain.
/domain/dns/list Returns the list of domain DNS entries.
/domain/dns/list/count Returns the number of domain DNS entries.
/domain/dns/remove Remove DNS entry for domain.
/domain/expires Returns the expiration time for specified domain.
/domain/hide It hides domain on domain list.
/domain/list It returns the list of domains on user account.
/domain/list/count It returns the number of domains on user account.
/domain/note/get It gets note for domain.
/domain/note/set It sets note for domain.
/domain/ns/get Returns name servers for domain.
/domain/ns/set Set pointing name servers for domain Nameservers allowed to use: - existing DNS from external domain ex. ns1.aftermarket.pl, ns2.aftermarket.pl - existing DNS from $name - non existing DNS from $name with $ips provided.
/domain/past/list Returns the list of domains that were on user account.
/domain/past/list/count Returns the number of domains that were on user account.
/domain/price/get Returns domain price.
/domain/reactivate Reactivates expiring domain.
/domain/redirect/get Returns domain redirection settings.
/domain/redirect/set Set domain redirection settings.
/domain/renew Renew domain for given period.
/domain/tag/assign It assigns tags to domain. Tag will be created if not exists.
/domain/tag/list It returns the list of tags that are assigned to domain.
/domain/tag/remove It removes tag which is assigned to domain.
/domain/unhide It unhides domain on domain list.
/future/add Register domain future.
/future/authinfo Returns the AuthInfo code for specified domain future.
/future/check Check status for input domains for future registration.
/future/contact/get Returns contact profile id for domain future.
/future/contact/set Set contact profile for domain future.
/future/created Returns the creation time for specified domain future.
/future/expires Returns the expiration time for specified domain future.
/future/list Returns the list of domain futures on user account.
/future/list/count Returns the number of domain futures on user account.
/future/note/get It gets note for domain option.
/future/note/set It sets note for domain option.
/future/past/list Returns the list of domain futures that were realized on user account.
/future/past/list/count Returns the number of domain futures that were realized on user account.
/future/renew Renew domain future.
/idn/decode Converts domain name to Punycode.
/idn/encode Converts domain name from Punycode.
/listing/get Returns the information about domain offered for sale.
/listing/list Returns the list of domains offered for sale. The marketplace is searched according to specified criteria. All criteria are optional and can be omitted.
/listing/list/count Returns the number of domains offered for sale. The marketplace is searched according to specified criteria. All criteria are optional and can be omitted.
/operation/list Returns the list of financial operations.
/operation/list/count Returns the number of financial operations.
/order/list Returns the list of ordered operations.
/order/list/count Returns the number of user domains to catch.
/order/prolong Prolong order.
/order/resign Resign from order.
/order/resume Resume order.
/order/suspend Suspend order.
/seller/auction/add Inserts a new auction into the system.
/seller/auction/cancel Cancel an active auction.
/seller/auction/description/set Add description to auction.
/seller/auction/endtime/prolong Change auction end time.
/seller/auction/invited/add Invites a bidder to a private auction.
/seller/auction/invited/delete Removes bidder invitation from a private auction.
/seller/auction/invited/list Returns the list of invited bidders for a private auction.
/seller/auction/invited/list/count Returns the number of invited bidders for a private auction.
/seller/auction/lastminute/add Inserts a new auction into the system for a soon expiring domain..
/seller/auction/list Returns the list of active auctions listed by the user.
/seller/auction/list/count Returns the number of active auctions listed by the user.
/seller/auction/note/get It gets private note for auction.
/seller/auction/note/set It sets private note for auction.
/seller/auction/option/add Inserts a new future auction into the system.
/seller/auction/past/list Returns the list of finished auctions listed by the user.
/seller/auction/past/list/count Returns the number of finished auctions listed by the user.
/seller/auction/price/set Change auction prices..
/seller/blacklist/add Add bidder to blacklist.
/seller/blacklist/list Returns the list of blocked bidders.
/seller/blacklist/list/count Returns the number of blocked bidders.
/seller/blacklist/remove Removes bidder from blacklist.
/seller/catalog/add It adds user's marketplace catalog.
/seller/catalog/domain/add It adds domain to marketplace catalog.
/seller/catalog/domain/list It retrieves the list of domains user's catalogs.
/seller/catalog/domain/list/count It retrieves the number of domains in user's catalogs.
/seller/catalog/domain/remove It removes domain from user's marketplace catalog.
/seller/catalog/get It gets user's marketplace catalog.
/seller/catalog/list It retrieves the list of user's marketplace catalogs.
/seller/catalog/list/count It retrieves the number of user's catalogs.
/seller/catalog/modify It edits user's marketplace catalog.
/seller/catalog/remove It deletes user's marketplace catalog.
/seller/category/available Get number of available categories that can be set to domain at marketplace by user.
/seller/counteroffer/add Make a counteroffer.
/seller/counteroffer/cancel Cancel counteroffer made by seller.
/seller/counteroffer/get Returns submitted counteroffer. The seller can propose a higher price to the buyer, and such proposition is called a counteroffer.
/seller/counteroffer/list Returns the list of active submitted counteroffers. The seller can propose a higher price to the buyer, and such proposition is called a counteroffer..
/seller/counteroffer/list/count Returns the list of active submitted counteroffers. The seller can propose a higher price to the buyer, and such proposition is called a counteroffer.
/seller/counteroffer/past/list Returns the list of inactive submitted counteroffers.
/seller/counteroffer/past/list/count Returns the number of inactive submitted counteroffers.
/seller/domain/group Creates a group of domains.
/seller/domain/ungroup Ungroup a group of domains.
/seller/escrow/add Insert new escrow transaction into the system.
/seller/escrow/cancel Cancel by seller escrow transaction.
/seller/escrow/extend Prolong payment deadline for escrow transaction.
/seller/escrow/list Returns the list of escrows, in which user sells domains.
/seller/escrow/list/count Returns the number of escrows, in which user sells domains.
/seller/escrow/note/get It gets private note for escrow.
/seller/escrow/note/set It sets private note for escrow.
/seller/hire/add Insert new hire transaction into the system.
/seller/hire/cancel Cancel by seller hire transaction.
/seller/hire/close Close by seller a hire transaction, in which buyer has not paid installment.
/seller/hire/list Returns the list of hire transactions, in which user sells domains.
/seller/hire/list/count Returns the number of hire transactions, in which user sells domains.
/seller/hire/note/get It gets private note for hire.
/seller/hire/note/set It sets private note for hire.
/seller/hire/plan/add It adds new hire plan for selling on marketplace.
/seller/hire/plan/list It gets the list of hire plans for selling on marketplace.
/seller/hire/plan/list/count It gets the number of hire plans for selling on marketplace.
/seller/hire/plan/modify It modifies hire plan for selling on marketplace.
/seller/hire/plan/remove It removes hire plan for marketplace.
/seller/hire/reactivate Reactivate unpaid hire transaction.
/seller/lastminute/price/get It gets default last minute auction start price.
/seller/lastminute/price/set It sets default last minute auction start price.
/seller/listing/description/get It gets description assigned to domain for sale.
/seller/listing/description/set It sets description assigned to domain for sale.
/seller/listing/get Returns the information about domain offered for sale on user account.
/seller/listing/list Returns the list of domains for sale listed on user account.
/seller/listing/list/count Returns the number of domains for sale listed on user account.
/seller/listing/options/get It gets options that are assigned to domain for sale.
/seller/listing/options/set It sets user marketplace listing options.
/seller/listing/set Sets domain for sale. NOTE! This function may adjust the domain prices if they are too high. Therefore you must always check the returned object to see what prices have been set..
/seller/offer/accept Accepts purchase offer. An Escrow transaction for specified domain is started with the price indicated in the offer by the buyer.
/seller/offer/get Returns information about a domain purchase offer.
/seller/offer/list Returns the list of active received offers.
/seller/offer/list/count Returns the number of active received offers.
/seller/offer/past/list Returns the list of inactive received offers.
/seller/offer/past/list/count Returns the number of inactive received offers.
/seller/offer/reject Rejects a received offer. The domain purchase offer is rejected and becomes inactive.
/seller/options/get It gets options that are assigned to domains for sale.
/seller/options/set It sets user marketplace listing options.
/seller/rating It gets information about a seller.
/seller/rental/add It inserts new rental transaction into the system.
/seller/rental/cancel It cancels rental transaction.
/seller/rental/close It closes rental transaction after payment deadline.
/seller/rental/finish It terminates, by lessor, rental transaction.
/seller/rental/list It returns the list of rental transactions, in which user is a lessor.
/seller/rental/list/count It returns the number of rental transactions, in which user is a lessee.
/seller/rental/note/get It gets private note for rental.
/seller/rental/note/set It sets private note for rental.
/seller/rental/reactivate It reactivates unpaid rental transaction.
/seller/sold/list It retrieves the list of domains sold by the user.
/seller/sold/list/count It retrieves the number of domains sold by the user.
/settings/autorenew/get It gets default autorenewal setting for registered domains, hostings or futures.
/settings/autorenew/set It sets default autorenewal setting for registered domains, hostings or futures.
/settings/dns/get Get user default name servers.
/settings/dns/set Set user default name servers.
/time/format Formats Unix timestamp to a human-readable date.
/time/get Retrieves current time as Unix timestamp.
/transfer/future/in/add Order domain option transfer into your account. If correct authinfo code passed for domain option, then transfer to your account will be ordered. If domain option owner confirms the transfer, then domain transfer is performed.
/transfer/future/in/cancel Cancel domain option transfer.
/transfer/future/in/get Returns information about an incoming domain option transfer.
/transfer/future/in/list Returns the list of incoming domain option transfers.
/transfer/future/in/list/count Returns the number of incoming domain option transfers.
/transfer/future/in/resend Resend confirmation email for domain option transfer.
/transfer/future/incoming/accept Accepts incoming future transfer that was initiated by another user.
/transfer/future/incoming/get Returns information about incoming future transfer that was initiated by another user.
/transfer/future/incoming/list Returns the list of incoming future transfers that were initiated by another user.
/transfer/future/incoming/list/count Returns the number of incoming future transfers that were initiated by another user.
/transfer/future/incoming/reject Rejects incoming future transfer that was initiated by another user.
/transfer/future/out/add Start outgoing transfer for domain option to other account.
/transfer/future/out/cancel Cancel outgoing transfer for future to other account.
/transfer/future/out/get Returns information about an outgoing domain option transfer.
/transfer/future/out/list Returns the list of outgoing domain option transfers.
/transfer/future/out/list/count Returns the number of outgoing domain option transfers.
/transfer/in/add Order domain transfer into your account. If correct authinfo code passed for domain, then transfer to your account will be ordered. If domain owner confirms the transfer, then domain transfer is performed. If paid transfer required and olnyFreeTransfer parameter is set to true, then error will be thrown. Please set onlyFreeTransfer parameter to false if you allow to start payable transfer.
/transfer/in/cancel Cancel domain transfer.
/transfer/in/get Returns information about an incoming domain transfer.
/transfer/in/list Returns the list of incoming domain transfers.
/transfer/in/list/count Returns the number of incoming domain transfers.
/transfer/in/resend Resend confirmation email for domain transfer.
/transfer/incoming/accept Accepts incoming domain transfer that was initiated by another user.
/transfer/incoming/get Returns information about incoming domain transfer that was initiated by another user.
/transfer/incoming/list Returns the list of incoming domain transfers that were initiated by another user.
/transfer/incoming/list/count Returns the number of incoming domain transfers that were initiated by another user.
/transfer/incoming/reject Rejects incoming domain transfer that was initiated by another user.
/transfer/out/add Start outgoing transfer for domain to other account.
/transfer/out/cancel Cancel outgoing transfer for domain to other account.
/transfer/out/get Returns information about an outgoing domain transfer.
/transfer/out/list Returns the list of outgoing domain transfers.
/transfer/out/list/count Returns the number of outgoing domain transfers.