Top List

This API operation is returning different models based on the Type. To clarify we've added all request and response options below.

Note: All top lists only returns currently active users in the scope of the selected top list. For example; when a user is in the top EscortViews now and changes their profile to non-escort, it will be removed from the list.

URL / Endpoint

Need help with Postman?

GET /v1/lists/getTopList

Requests

To return the top view list you can use the table below.

Property	Type	Description
`NumberOfRecords`	integer	The number of records the API will return. Default is `10`.
`Type`	string	Required. Options: `ProfileViews`, `EscortViews`, `PhoneChatViews` and `WebcamViews`.
`DateRange`	string	Required. The range of the top list. Options: `AllTime`, `LastYear`,`LastMonth`, `LastWeek`, `ThisYear`, `ThisMonth`, `ThisWeek`, `Today` and `Yesterday`
`VATIPAddress`	string	If supplied it will check the country of that IP address and add the local VAT to the price. For example: IP addresses from the UK will add `20 %` to the price.
`VATUserID`	integer	If supplied it will overrule `VATIPAddress`. It will get the users vat details and add the vat to the price.

To return the top ratings list you can use the table below.

Property	Type	Description
`NumberOfRecords`	integer	The number of records the API will return. Default is `10`.
`Type`	string	Required. Options: `EscortRatings`, `PhoneChatRatings` and `WebcamRatings`.
`DateRange`	string	Required. The range of the top list. Options: `AllTime`, `LastYear`,`LastMonth`, `LastWeek`, `ThisYear`, `ThisMonth`, `ThisWeek`, `Today` and `Yesterday`
`VATIPAddress`	string	If supplied it will check the country of that IP address and add the local VAT to the price. For example: IP addresses from the UK will add `20 %` to the price.
`VATUserID`	integer	If supplied it will overrule `VATIPAddress`. It will get the users vat details and add the vat to the price.

To return the top movie views list you can use the table below.

Property	Type	Description
`NumberOfRecords`	integer	The number of records the API will return. Default is `10`.
`Type`	string	Required. Option: `MovieViews`.
`DateRange`	string	Required. The range of the top list. Options: `AllTime`, `LastYear`,`LastMonth`, `LastWeek`, `ThisYear`, `ThisMonth`, `ThisWeek`, `Today` and `Yesterday`
`VATIPAddress`	string	If supplied it will check the country of that IP address and add the local VAT to the price. For example: IP addresses from the UK will add `20 %` to the price.
`VATUserID`	integer	If supplied it will overrule `VATIPAddress`. It will get the users vat details and add the vat to the price.

To return the top movie collection views list you can use the table below.

Property	Type	Description
`NumberOfRecords`	integer	The number of records the API will return. Default is `10`.
`Type`	string	Required. Option: `MovieCollectionViews`.
`DateRange`	string	Required. The range of the top list. Options: `AllTime`, `LastYear`,`LastMonth`, `LastWeek`, `ThisYear`, `ThisMonth`, `ThisWeek`, `Today` and `Yesterday`

To return the top sold private gallery list you can use the table below.

Property	Type	Description
`NumberOfRecords`	integer	The number of records the API will return. Default is `10`.
`Type`	string	Required. Option: `PrivateGallery`.
`DateRange`	string	Required. The range of the top list. Options: `AllTime`, `LastYear`,`LastMonth`, `LastWeek`, `ThisYear`, `ThisMonth`, `ThisWeek`, `Today` and `Yesterday`
`VATIPAddress`	string	If supplied it will check the country of that IP address and add the local VAT to the price. For example: IP addresses from the UK will add `20 %` to the price.
`VATUserID`	integer	If supplied it will overrule `VATIPAddress`. It will get the users vat details and add the vat to the price.

To return the top movie rental ratings list you can use the table below.

Property	Type	Description
`NumberOfRecords`	integer	The number of records the API will return. Default is `10`.
`Type`	string	Required. Option: `RentalRatings`.
`DateRange`	string	Required. The range of the top list. Options: `AllTime`, `LastYear`,`LastMonth`, `LastWeek`, `ThisYear`, `ThisMonth`, `ThisWeek`, `Today` and `Yesterday`
`VATIPAddress`	string	If supplied it will check the country of that IP address and add the local VAT to the price. For example: IP addresses from the UK will add `20 %` to the price.
`VATUserID`	integer	If supplied it will overrule `VATIPAddress`. It will get the users vat details and add the vat to the price.

To return the top rental purchases list you can use the table below.

Property	Type	Description
`NumberOfRecords`	integer	The number of records the API will return. Default is `10`.
`Type`	string	Required. Option: `RentalPurchases`.
`DateRange`	string	Required. The range of the top list. Options: `AllTime`, `LastYear`,`LastMonth`, `LastWeek`, `ThisYear`, `ThisMonth`, `ThisWeek`, `Today` and `Yesterday`
`VATIPAddress`	string	If supplied it will check the country of that IP address and add the local VAT to the price. For example: IP addresses from the UK will add `20 %` to the price.
`VATUserID`	integer	If supplied it will overrule `VATIPAddress`. It will get the users vat details and add the vat to the price.

Request Information

HTTP Method / Verb

Parameters can be passed to this operation using the HTTP GET method by passing parameters over the query string of the URI.

Headers

The REST API uses HTTP request headers to determine what data type is returned or to authenticate the developer's API key. More information can be found in the overview section.

This endpoint has the following optional headers:

Headers	Value
`X-MaskImages`	`1`	What's this?

Authentication

Your API-Key is required with every request and can be passed in as a header or a query-string parameter. Don't have an API-Key? Get one now.

Samples

GET method

https://api-sandbox.adultwork.com/v1/lists/getTopList?apiKey={your-api-key}&NumberOfRecords=10&Type=ProfileViews&DateRange=Today

Responses

When using the type ProfileViews, EscortViews, PhoneChatViews or WebcamViews the following response is returned.

Property	Type	Description
`Result`	Array of aws:TopListView	List of TopListViews.

When using the type EscortRatings, PhoneChatRatings or WebcamRatings the following response is returned.

Property	Type	Description
`Result`	Array of aws:TopListRating	List of TopListRatings.

When using the type MovieViews the following response is returned.

Property	Type	Description
`Result`	Array of aws:TopListMovieView	List of TopListMovieViews.

When using the type MovieCollectionViews the following response is returned.

Property	Type	Description
`Result`	Array of aws:TopListMovieCollectionView	List of TopListMovieCollectionViews.

When using the type PrivateGallery the following response is returned.

Property	Type	Description
`Result`	Array of aws:TopListPrivateGallery	List of TopListPrivateGallery.

When using the type RentalRatings the following response is returned.

Property	Type	Description
`Result`	Array of aws:TopListRentalRating	List of TopListRentalRatings.

When using the type RentalPurchases the following response is returned.

Property	Type	Description
`Result`	Array of aws:TopListRentalPurchase	List of TopListRentalPurchases.

Response Sample

The following example returns 1 result of the TopListView.

JSON
XML

[
  {
    "Ranking": 1,
    "NumberOfViews": 999,
    "LocationProximityMiles": 0,
    "LocationProximityKilometres": 0,
    "ProfileThumbnailSafe": true,
    "HasProfileThumbnail": false,
    "ProfileThumbnailURL": "",
    "ProfileSquareSafe": true,
    "ProfileSquareURL": "",
    "UserID": 123456,
    "Nickname": "JosepheneBlogs",
    "Summary": "Hey guys - check out my profile!",
    "Gender": "Female",
    "IsTVTS": false,
    "Age": 21,
    "Orientation": "Bi-curious",
    "Country": "United Kingdom",
    "Region": "South East",
    "County": "London",
    "Town": "Westminster",
    "LocationZipCode": "KT14",
    "Views": 999,
    "MemberSince":"2013-08-09T10:15:37.517",
    "LastLoggedIn":"2014-06-20T09:11:20.053",
    "Verified": false,
    "IsEscort": true,
    "DoesOutCalls": true,
    "DoesInCalls": true,
    "IsWebcam": false,
    "IsPhoneChat": false,
    "IsSMSChat": false,
    "IsAlternative": false,
    "IsDirectCam": false,
    "IsDirectIM": false,
    "IsDirectChat": true,
    "AvailableTodayEscort": false,
    "AvailableNowWebcam": true,
    "AvailableNowPhoneChat": true,
    "DirectCam": {
        "ModeID": null,
        "Mode": "",
        "ModeColour": null,
        "ChatOnly": false,
        "DoesFreePreview": false,
        "DoesFreeToGuest": false,
        "DoesGroup": true,
        "GroupPPM": "2.50",
        "DoesPrivate": true,
        "PrivatePPM": "3.50",
        "DirectCamLink": "https://www.adultwork.com/Player6.0/PlayerLauncher.asp?U=123456",
        "AllowVoyeur": false,
        "TipsOnly": false,
        "HasSpecialOffers": false,
        "HasShows": true
    },
    "DirectChat": {
      "PPM": "1,00"
    },
    "HasGallery": true,
    "HasPrivateGallery": true,
    "HasMovieClips": false,
    "HasMovieRentals": false,
    "HasSaleItems": false,
    "Ratings": {
      "Total": 1001,
      "Positive": 1001,
      "Neutral": 0,
      "Negative": 0,
      "Ratings": 1001,
      "Disputes": 0
    },
    "IsCouple": false,
    "InGroup": true,
    "GroupID":1 ,
    "GroupName": "My AdultWork Group",
    "ProfileURL": "http://www.adultwork.com/123456",
    "RatingsURL": "http://www.adultwork.com/dlgExtRatings.asp?U=123456"
  }
]

<ArrayOfanyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <anyType xmlns:d2p1="http://schemas.datacontract.org/2004/07/API.Models.Rankings" i:type="d2p1:RankingResultProfile">
        <Age xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">21</Age>
        <AvailableNowPhoneChat xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">false</AvailableNowPhoneChat>
        <AvailableNowWebcam xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">false</AvailableNowWebcam>
        <AvailableTodayEscort xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">true</AvailableTodayEscort>
        <Country xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">United Kingdom</Country>
        <County xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">London</County>
       <DirectCam xmlns:d4p1="http://schemas.datacontract.org/2004/07/API.Models.Profile">
	<d4p1:AllowVoyeur>false</d4p1:AllowVoyeur>
	<d4p1:ChatOnly>false</d4p1:ChatOnly>
	<d4p1:DirectCamLink>https://www.adultwork.com/Player6.0/PlayerLauncher.asp?U=197704</d4p1:DirectCamLink>
	<d4p1:DoesFreePreview>false</d4p1:DoesFreePreview>
	<d4p1:DoesFreeToGuest>false</d4p1:DoesFreeToGuest>
	<d4p1:DoesGroup>true</d4p1:DoesGroup>
	<d4p1:DoesPrivate>true</d4p1:DoesPrivate>
	<d4p1:GroupPPM>2.50</d4p1:GroupPPM>
	<d4p1:HasSpecialOffers>false</d4p1:HasSpecialOffers>
	<d4p1:Mode></d4p1:Mode>
	<d4p1:ModeColour i:nil="true" />
	<d4p1:ModeID i:nil="true" />
	<d4p1:PrivatePPM>3.50</d4p1:PrivatePPM>
	<d4p1:TipsOnly>false</d4p1:TipsOnly>
	<d4p1:HasShows>false</d4p1:HasShows>              
</DirectCam>
        <DirectChat xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">
            <PPM>1,00</PPM>
        </DirectChat>
        <DoesInCalls xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">true</DoesInCalls>
        <DoesOutCalls xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">true</DoesOutCalls>
        <Gender xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">Female</Gender>
        <GroupID xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">1</GroupID>
        <GroupName xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">My AdultWork Group</GroupName>
        <HasGallery xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">true</HasGallery>
        <HasMovieClips xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">false</HasMovieClips>
        <HasMovieRentals xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">false</HasMovieRentals>
        <HasPrivateGallery xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">true</HasPrivateGallery>
        <HasSaleItems xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">false</HasSaleItems>
        <InGroup xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">true</InGroup>
        <IsAlternative xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">false</IsAlternative>
        <IsCouple xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">false</IsCouple>
        <IsDirectCam xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">false</IsDirectCam>
        <IsDirectChat xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">false</IsDirectChat>
        <IsDirectIM xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">false</IsDirectIM>
        <IsEscort xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">true</IsEscort>
        <IsPhoneChat xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">false</IsPhoneChat>
        <IsSMSChat xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">false</IsSMSChat>
        <IsTVTS xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">false</IsTVTS>
        <IsWebcam xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">false</IsWebcam>
        <LastLoggedIn xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">2014-06-20T09:11:20.053</LastLoggedIn>
        <LocationZipCode xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">KT14</LocationZipCode>
        <MemberSince xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">2013-08-09T10:15:37.517</MemberSince>
        <Nickname xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">JosepheneBlogs</Nickname>
        <Orientation xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">Bi-curious</Orientation>
        <ProfileURL xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">http://www.adultwork.com/123456</ProfileURL>
        <Ratings xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">
            <Disputes>0</Disputes>
            <Negative>0</Negative>
            <Neutral>0</Neutral>
            <Positive>1001</Positive>
            <Ratings>1001</Ratings>
            <Total>1001</Total>
        </Ratings>
        <RatingsURL xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">http://www.adultwork.com/dlgExtRatings.asp?U=123456</RatingsURL>
        <Region xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">South East<Region>
        <Summary xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">Hey guys - check out my profile!</Summary>
        <Town xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">Westminster</Town>
        <UserID xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">123456</UserID>
        <Verified xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">false</Verified>
        <Views xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">999</Views>
        <ProfileSquareSafe>true</ProfileSquareSafe>
        <ProfileSquare i:nill="true" />
        <HasProfileThumbnail xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">false</HasProfileThumbnail>
        <LocationProximityKilometres xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">0</LocationProximityKilometres>
        <LocationProximityMiles xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">0</LocationProximityMiles>
        <ProfileThumbnailURL xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile"></ProfileThumbnailURL>
        <d2p1:NumberOfViews>999</d2p1:NumberOfViews>
        <d2p1:Ranking>1</d2p1:Ranking>
    </anyType>
</ArrayOfanyType>