apps/search API v7

apps/search API ^v7

Information

Name

Path

apps/

Version

URL

http://ws75.aptoide.com/api/7/apps/search

Alias

listSearchApps

Alias URL

http://ws75.aptoide.com/api/7/listSearchApps

Authentication

TOKEN

ACL

Name	Value
Level	Public
Domain Restricted	Yes
Allow CORS	Yes (only specific origins)
Allowed CORS Headers	Cache-Control, Pragma, Content-Type
Iframe Policy	Only specific origins

Cache

Type	Min	Max
server	30 minutes	30 minutes
client	2 hours	2 hours

Description

Get a list of searched apps

Arguments

This endpoint has the following arguments:

Name

Input

Description

Details

aab

BOOLEAN

Enable AAB apps.

Default	false
Example	true

access_token

TOKEN

Authentication access token.

Default	null
Properties	• Max length: 512
Example	"cGF1bG8udHJlemVudG9zQGFwdG9pZGUuY29tOkF"

api_key

TOKEN

Authentication API key.

Default	null
Properties	• Max length: 512
Example	"4WBEPQBJHHCIHJVRVEMU2OLQA55T22FVYJ32HHMF3PXQ7TGNFJIAIIJ6"

apk_required_features

LIST<PACKAGE_NAME>

APK required features to filter by.

Default	[]
Properties	• Max length: 8
Example	"android.hardware.wifi,android.hardware.touchscreen"

apk_tags

LIST<STRING>

Apk tags.

Default	[]
Properties	• Max length: 100• Input (STRING): › Max length: 128
Example	"alpha,beta"

appc_only

BOOLEAN

List only apps with appc billing or advertising

Default	false
Example	true

appc_types

LIST<STRING>

AppcTypes flags (include).

Default	[]
Properties	• Max length: 3• Input (STRING): › Allowed values: "advertising", "billing", "eskills"
Example	"billing,advertising"

cdn

STRING

CDN type selector.

Default	"pool"
Properties	• Allowed values: "pool", "web", "apw", "cdn9"
Example	"web"

info

BOOLEAN

Show API info page.

Default	false
Example	true

language

STRING

Language.

Default	"en"
Properties	• Min length: 2 • Max length: 6
Example	"pt_PT"

limit

+INT31_NULL

Lists items limit.

Default	25
Example	15

mature

BOOLEAN

Enable mature content.

Default	true
Example	false

not_apk_required_features

LIST<PACKAGE_NAME>

APK required features to filter from (exclude).

Default	[]
Properties	• Max length: 8
Example	"android.hardware.wifi,android.hardware.touchscreen"

not_apk_tags

LIST<STRING>

Apk tags (exclude).

Default	[]
Properties	• Max length: 100• Input (STRING): › Max length: 128
Example	"alpha,beta"

not_package_tags

LIST<STRING>

Package tags (exclude).

Default	[]
Properties	• Max length: 100• Input (STRING): › Max length: 128
Example	"system"

offset

UINT32

Lists items offset.

Default	0
Example	5

package_tags

LIST<STRING>

Package tags.

Default	[]
Properties	• Max length: 100• Input (STRING): › Max length: 128
Example	"system"

SBASE64

Base 64 encoded query string of device specs.

Default	null
Properties	• Max length: 1024
Example	"bWF4U2RrPTE5Jm1heFNjcmVlbj1ub3JtYWwmbWF4R2xlcz0yLjA"

query

STRING

Search query.

Default	null
Properties	• Min length: 2 • Max length: 100
Example	"aptoide"

refresh

BOOLEAN

Refresh request.

Default	false
Example	true

store_ids

LIST<+INT31>

Store IDs.

Default	[]
Properties	• Truncate • Max length: 100
Example	"15,1113"

store_names

LIST<DOMAIN_LABEL>

Store names.

Default	[]
Properties	• Truncate • Max length: 100
Example	"apps,savou"

stores_auth_map

ARRAY<LIST<STRING>>

Stores authentication map as store identifier→credentials key pairs
The credentials are 2 element lists as [user,SHA1(password)].

Default	[]
Properties	• Truncate • Max length: 100• Input (LIST): › Length: 2
Example	{ "apps": [ "aptuser", "222393ba85b9c2131c3ce7b3c2fcb6926de54782" ] }

trusted

BOOLEAN

List trusted apps only.

Default	false
Example	true

use_qa_index

BOOLEAN

Use Quality Assurance index to prioritize QA reviewed apps in the catalog.

Default	false
Example	true

Mandatory Arguments

This endpoint requires 1 of the following possible combinations of arguments:

• query

Arguments Aliases

This endpoint has the following possible arguments aliases:

• language: lang

• store_ids: store_id

• store_names: store_name

• apk_tags: apk_tag

• not_apk_tags: not_apk_tag

• apk_required_features: apk_required_feature

• not_apk_required_features: not_apk_required_feature

• package_tags: package_tag

• not_package_tags: not_package_tag

Inputs

The input types used by the existing arguments in this endpoint are the following:

Name	Description	Examples
+INT31_NULL	31 bits positive nullable integer: 0 to 2147483647 (0 = NULL)	0 5024 70733
ARRAY<LIST<STRING>>	Associative array of elements as: List of items as: String of characters	"key1:a,foobar,Some text,2:[\"a\",\"foobar\",\"Some text\"]" { "key1": "a,foobar,Some text", "2": ["a", "foobar", "Some text"] }
BOOLEAN	Boolean: FALSE (0, f, false, no, off) or TRUE (1, t, true, yes, on)	0 1 true "f"
LIST<+INT31>	List of items as: 31 bits positive integer: 1 to 2147483647	"1,5024,70733" [1, 5024, 70733]
LIST<DOMAIN_LABEL>	List of items as: Web domain label	"site,my-domain-label,some-other-domain-label" [ "site", "my-domain-label", "some-other-domain-label" ]
LIST<PACKAGE_NAME>	List of items as: Java package name	"com.package.vendor,cm.aptoide.pt,com.android.package.sub.foobar" [ "com.package.vendor", "cm.aptoide.pt", "com.android.package.sub.foobar" ]
LIST<STRING>	List of items as: String of characters	"a,foobar,Some text" ["a", "foobar", "Some text"]
SBASE64	String of characters in URL safe base64	"Zm9v" "YmFzZTY0Kw" "YmFyQGZvby5jb20"
STRING	String of characters	"a" "foobar" "Some text"
TOKEN	Tokenized string of characters	"ja-HK_1" "AjgI74-ash_86jhgasorw-5234" "1Eiayn9Suo3fcgKrQq8qHwCz3MP"
UINT32	32 bits unsigned integer: 0 to 4294967295	0 5024 60422124

Outputs

This endpoint may output a response in one of the following types:

Name	Type	Description	MIME Type	Properties
json	JSON	JavaScript Object Notation	application/json

Example

An example of the usage of this endpoint can be seen below:

Request URL:

http://ws75.aptoide.com/api/7/apps/search/query=aptoide/limit=3

Response (json):

{
   "info": {
      "status": "OK",
      "time": {
         "seconds": 0.15372920036315918,
         "human": "154 milliseconds"
      }
   },
   "datalist": {
      "total": 169,
      "count": 3,
      "offset": 0,
      "limit": 3,
      "next": 3,
      "hidden": 0,
      "loaded": true,
      "list": [
         {
            "id": 67532558,
            "name": "Aptoide",
            "package": "cm.aptoide.pt",
            "uname": "aptoide",
            "size": 21423581,
            "icon": "https://pool.img.aptoide.com/rmota/a4a27be4bb6f17cd3fbb159dd7344146_icon.png",
            "graphic": "https://pool.img.aptoide.com/rmota/48c1f18f7d65f38d0b19af5f47015e9c_fgraphic.jpg",
            "added": "2015-10-15 20:09:23",
            "modified": "2024-04-30 15:46:43",
            "updated": "2024-05-01 12:33:46",
            "uptype": "regular",
            "developer": {
               "id": 66251,
               "name": "Aptoide"
            },
            "store": {
               "id": 798468,
               "name": "rmota",
               "avatar": "https://pool.img.aptoide.com/rmota/9b49f6ea48987bb23c6d0782f76c4f69_ravatar.png",
               "appearance": {
                  "theme": "red",
                  "description": "This is a great App store"
               },
               "stats": {
                  "apps": 561,
                  "subscribers": 62029,
                  "downloads": 20524585
               }
            },
            "file": {
               "vername": "9.21.0.1",
               "vercode": 12025,
               "md5sum": "3a91cde553aa5269178ff9cd9ffa7574",
               "filesize": 21423581,
               "path": "https://pool.apk.aptoide.com/rmota/cm-aptoide-pt-12025-67532558-3a91cde553aa5269178ff9cd9ffa7574.apk",
               "path_alt": "https://pool.apk.aptoide.com/rmota/alt/Y20tYXB0b2lkZS1wdC0xMjAyNS02NzUzMjU1OC0zYTkxY2RlNTUzYWE1MjY5MTc4ZmY5Y2Q5ZmZhNzU3NA.apk",
               "tags": [],
               "malware": {
                  "rank": "TRUSTED"
               }
            },
            "stats": {
               "downloads": 17220150,
               "pdownloads": 173697788,
               "rating": {
                  "avg": 4.19,
                  "total": 6522
               },
               "prating": {
                  "avg": 4.33,
                  "total": 20073
               }
            },
            "has_versions": true,
            "obb": null,
            "appcoins": {
               "advertising": false,
               "billing": false,
               "eskills": false
            },
            "urls": {

            }
         },
         {
            "id": 61286640,
            "name": "Aptoide Uploader",
            "package": "pt.caixamagica.aptoide.uploader",
            "uname": "aptoide-uploader",
            "size": 6709963,
            "icon": "https://pool.img.aptoide.com/rmota/78ff6dd364077161c4c5a6c821380794_icon.png",
            "graphic": "https://pool.img.aptoide.com/rmota/2c292446d3d25f420d945b81842da054_fgraphic.png",
            "added": "2015-11-05 15:15:23",
            "modified": "2021-12-27 12:23:47",
            "updated": "2024-05-01 19:15:37",
            "uptype": "regular",
            "developer": {
               "id": 66251,
               "name": "Aptoide"
            },
            "store": {
               "id": 798468,
               "name": "rmota",
               "avatar": "https://pool.img.aptoide.com/rmota/9b49f6ea48987bb23c6d0782f76c4f69_ravatar.png",
               "appearance": {
                  "theme": "red",
                  "description": "This is a great App store"
               },
               "stats": {
                  "apps": 561,
                  "subscribers": 62029,
                  "downloads": 20524585
               }
            },
            "file": {
               "vername": "3.0",
               "vercode": 171,
               "md5sum": "839935f90fe336416baf63bdf9e65e2e",
               "filesize": 6709963,
               "path": "https://pool.apk.aptoide.com/rmota/pt-caixamagica-aptoide-uploader-171-61286640-839935f90fe336416baf63bdf9e65e2e.apk",
               "path_alt": "https://pool.apk.aptoide.com/rmota/alt/cHQtY2FpeGFtYWdpY2EtYXB0b2lkZS11cGxvYWRlci0xNzEtNjEyODY2NDAtODM5OTM1ZjkwZmUzMzY0MTZiYWY2M2JkZjllNjVlMmU.apk",
               "tags": [],
               "malware": {
                  "rank": "TRUSTED"
               }
            },
            "stats": {
               "downloads": 1254015,
               "pdownloads": 2496043,
               "rating": {
                  "avg": 4,
                  "total": 3133
               },
               "prating": {
                  "avg": 4.1,
                  "total": 5458
               }
            },
            "has_versions": true,
            "obb": null,
            "appcoins": {
               "advertising": false,
               "billing": false,
               "eskills": false
            },
            "urls": {

            }
         },
         {
            "id": 5840328,
            "name": "Aptoide Backup Apps",
            "package": "pt.aptoide.backupapps",
            "uname": "aptoide-backup-apps",
            "size": 2061067,
            "icon": "https://pool.img.aptoide.com/apps/e9e017c951ab8215f956aad9b227fb0c_icon.png",
            "graphic": "https://pool.img.aptoide.com/apps/6125dfe8e1954b54b2184c6bb2a00910.png",
            "added": "2012-09-13 23:21:38",
            "modified": "2023-06-23 10:29:08",
            "updated": "2017-10-20 09:49:42",
            "uptype": "aptbackup",
            "developer": {
               "id": 66251,
               "name": "Aptoide"
            },
            "store": {
               "id": 15,
               "name": "apps",
               "avatar": "https://pool.img.aptoide.com/apps/815872daa4e7a55f93cb3692aff65e31_ravatar.jpg",
               "appearance": {
                  "theme": "default",
                  "description": "Aptoide Official App Store"
               },
               "stats": {
                  "apps": 547542,
                  "subscribers": 3378205,
                  "downloads": 4635112659
               }
            },
            "file": {
               "vername": "2.1.1",
               "vercode": 20101,
               "md5sum": "06f6618179190d003142fcc67e4313d9",
               "filesize": 2061067,
               "path": "https://pool.apk.aptoide.com/apps/pt-aptoide-backupapps-20101-5840328-06f6618179190d003142fcc67e4313d9.apk",
               "path_alt": "https://pool.apk.aptoide.com/apps/alt/cHQtYXB0b2lkZS1iYWNrdXBhcHBzLTIwMTAxLTU4NDAzMjgtMDZmNjYxODE3OTE5MGQwMDMxNDJmY2M2N2U0MzEzZDk.apk",
               "tags": [],
               "malware": {
                  "rank": "TRUSTED"
               }
            },
            "stats": {
               "downloads": 837547,
               "pdownloads": 1869649,
               "rating": {
                  "avg": 4.04,
                  "total": 1038
               },
               "prating": {
                  "avg": 4.09,
                  "total": 2667
               }
            },
            "has_versions": true,
            "obb": null,
            "appcoins": {
               "advertising": false,
               "billing": false,
               "eskills": false
            },
            "urls": {

            }
         }
      ]
   }
}

Notes

To take full advantage on the usage of this endpoint, please take the following notes into consideration:

⚠

Authentication

Any authentication arguments should be sent using the POST method, ideally through an encrypted connection (HTTPS).

Errors

All the possible errors that may be replied during the usage of this endpoint are the following:

Name	Description	HTTP Code
API-1	Invalid value ... for argument '...'	400 Bad Request
API-2	Invalid output '...'	400 Bad Request
API-3	Missing mandatory arguments '...'	400 Bad Request
API-4	At least 1 node must be set	400 Bad Request
API-5	Malformed node at ...	400 Bad Request
API-6	Invalid node '...'	400 Bad Request
API-7	Missing mandatory arguments '...' for condition '...'	400 Bad Request
AUTH-1	Authentication required	401 Unauthorized
AUTH-2	Authentication failed: invalid '...'	401 Unauthorized
AUTH-3	Authentication failed: expired '...'	401 Unauthorized
AUTH-4	Authentication error	500 Internal Server Error
AUTH-5	Access denied: access level ... required	403 Forbidden
AUTH-6	Access denied: not in allowed groups	403 Forbidden
AUTH-7	Access denied: not in allowed countries	403 Forbidden
AUTH-8	Access denied: not in allowed IP addresses	403 Forbidden
AUTH-9	Access denied: not in allowed domains	403 Forbidden
AUTH-10	Access denied: not in allowed origins (CORS)	403 Forbidden
AUTH-11	Access denied: unauthorized user	403 Forbidden
AUTH-12	Access denied: unauthorized operation	403 Forbidden
AUTH-13	Access denied: invalid API key	401 Unauthorized
STORE-1	Store '...' not found	404 Not Found
STORE-2	Store '...' is pending approval	403 Forbidden
STORE-3	Store '...' is private: authentication required	401 Unauthorized
STORE-4	Store '...' is private: authentication failed (invalid '...')	401 Unauthorized
STORE-5	Store '...' is private: access denied	403 Forbidden
STORE-6	Store '...' was closed	403 Forbidden
STORE-7	Store '...' was suspended	410 Gone
SYS-0	(╯°□°）╯︵ ┻━┻	417 Expectation Failed
SYS-1	An unknown system error occurred, please try again	500 Internal Server Error
SYS-2	The system is down for maintenance, please try again later	503 Service Unavailable
SYS-3	Operation timed out, please try again later	504 Gateway Timeout