> For the complete documentation index, see [llms.txt](https://docs.pullbay.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pullbay.com/api-reference/appstore.md).

# Appstore

Apple App Store: app lookup, search, similar apps, reviews, developer apps.

## Get a single application by App ID or Bundle ID

> Returns one application. Provide exactly one of \`appId\` or \`bundleId\`.

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"appstore","description":"Apple App Store: app lookup, search, similar apps, reviews, developer apps."}],"servers":[{"url":"https://dashboard.pullbay.com/api"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Application":{"type":"object","properties":{"id":{"type":"integer"},"appId":{"type":"string"},"title":{"type":"string"},"url":{"type":"string","format":"uri"},"description":{"type":"string"},"icon":{"type":"string","format":"uri"},"genres":{"type":"array","items":{"type":"string"}},"genreIds":{"type":"array","items":{"type":"string"}},"primaryGenre":{"type":"string"},"primaryGenreId":{"type":"integer"},"contentRating":{"type":"string"},"languages":{"type":"array","items":{"type":"string"}},"size":{"type":"string"},"requiredOsVersion":{"type":"string"},"released":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"releaseNotes":{"type":"string"},"version":{"type":"string"},"price":{"type":"number"},"currency":{"type":"string"},"free":{"type":"boolean"},"developerId":{"type":"integer"},"developer":{"type":"string"},"developerUrl":{"type":"string","format":"uri"},"developerWebsite":{"type":"string","format":"uri"},"score":{"type":"number"},"reviews":{"type":"integer"},"currentVersionScore":{"type":"number"},"currentVersionReviews":{"type":"integer"},"screenshots":{"type":"array","items":{"type":"string","format":"uri"}},"ipadScreenshots":{"type":"array","items":{"type":"string","format":"uri"}},"appletvScreenshots":{"type":"array","items":{"type":"string","format":"uri"}},"supportedDevices":{"type":"array","items":{"type":"string"}}}},"Pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}},"ErrorEnvelope":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/appstore/apps":{"get":{"operationId":"getApp","summary":"Get a single application by App ID or Bundle ID","description":"Returns one application. Provide exactly one of `appId` or `bundleId`.","tags":["appstore"],"parameters":[{"name":"appId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d{8,12}$"}},{"name":"bundleId","in":"query","required":false,"schema":{"type":"string","maxLength":255,"pattern":"^[A-Za-z0-9.]+$"}},{"name":"country","in":"query","required":false,"schema":{"type":"string","minLength":2,"maxLength":2}},{"name":"lang","in":"query","required":false,"schema":{"type":"string","pattern":"^[a-z]{2,3}(-[a-z]{2,3})?$"}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Application"}},"pricing":{"$ref":"#/components/schemas/Pricing"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```

## Search applications by term

> Search the App Store for applications matching \`term\`. Use \`page\` for pagination or \`maxItems\` for a one-shot bulk pull (mutually exclusive).

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"appstore","description":"Apple App Store: app lookup, search, similar apps, reviews, developer apps."}],"servers":[{"url":"https://dashboard.pullbay.com/api"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Application":{"type":"object","properties":{"id":{"type":"integer"},"appId":{"type":"string"},"title":{"type":"string"},"url":{"type":"string","format":"uri"},"description":{"type":"string"},"icon":{"type":"string","format":"uri"},"genres":{"type":"array","items":{"type":"string"}},"genreIds":{"type":"array","items":{"type":"string"}},"primaryGenre":{"type":"string"},"primaryGenreId":{"type":"integer"},"contentRating":{"type":"string"},"languages":{"type":"array","items":{"type":"string"}},"size":{"type":"string"},"requiredOsVersion":{"type":"string"},"released":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"releaseNotes":{"type":"string"},"version":{"type":"string"},"price":{"type":"number"},"currency":{"type":"string"},"free":{"type":"boolean"},"developerId":{"type":"integer"},"developer":{"type":"string"},"developerUrl":{"type":"string","format":"uri"},"developerWebsite":{"type":"string","format":"uri"},"score":{"type":"number"},"reviews":{"type":"integer"},"currentVersionScore":{"type":"number"},"currentVersionReviews":{"type":"integer"},"screenshots":{"type":"array","items":{"type":"string","format":"uri"}},"ipadScreenshots":{"type":"array","items":{"type":"string","format":"uri"}},"appletvScreenshots":{"type":"array","items":{"type":"string","format":"uri"}},"supportedDevices":{"type":"array","items":{"type":"string"}}}},"Pagination":{"type":"object","properties":{"page":{"type":"integer","nullable":true},"hasNextPage":{"type":"boolean","nullable":true},"cursor":{"type":"string","nullable":true},"offset":{"type":"string","nullable":true,"description":"Numeric offset string for offset-paginated endpoints (e.g. Google Maps place search)."}}},"Pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}},"ErrorEnvelope":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/appstore/search":{"get":{"operationId":"searchApps","summary":"Search applications by term","description":"Search the App Store for applications matching `term`. Use `page` for pagination or `maxItems` for a one-shot bulk pull (mutually exclusive).","tags":["appstore"],"parameters":[{"name":"term","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":255}},{"name":"country","in":"query","required":false,"schema":{"type":"string","minLength":2,"maxLength":2}},{"name":"lang","in":"query","required":false,"schema":{"type":"string","pattern":"^[a-z]{2,3}(-[a-z]{2,3})?$"}},{"name":"maxItems","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":5}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Application"}},"pagination":{"$ref":"#/components/schemas/Pagination"},"pricing":{"$ref":"#/components/schemas/Pricing"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```

## Get similar applications

> Returns applications similar to the supplied one. Provide exactly one of \`appId\` or \`bundleId\`.

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"appstore","description":"Apple App Store: app lookup, search, similar apps, reviews, developer apps."}],"servers":[{"url":"https://dashboard.pullbay.com/api"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Application":{"type":"object","properties":{"id":{"type":"integer"},"appId":{"type":"string"},"title":{"type":"string"},"url":{"type":"string","format":"uri"},"description":{"type":"string"},"icon":{"type":"string","format":"uri"},"genres":{"type":"array","items":{"type":"string"}},"genreIds":{"type":"array","items":{"type":"string"}},"primaryGenre":{"type":"string"},"primaryGenreId":{"type":"integer"},"contentRating":{"type":"string"},"languages":{"type":"array","items":{"type":"string"}},"size":{"type":"string"},"requiredOsVersion":{"type":"string"},"released":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"releaseNotes":{"type":"string"},"version":{"type":"string"},"price":{"type":"number"},"currency":{"type":"string"},"free":{"type":"boolean"},"developerId":{"type":"integer"},"developer":{"type":"string"},"developerUrl":{"type":"string","format":"uri"},"developerWebsite":{"type":"string","format":"uri"},"score":{"type":"number"},"reviews":{"type":"integer"},"currentVersionScore":{"type":"number"},"currentVersionReviews":{"type":"integer"},"screenshots":{"type":"array","items":{"type":"string","format":"uri"}},"ipadScreenshots":{"type":"array","items":{"type":"string","format":"uri"}},"appletvScreenshots":{"type":"array","items":{"type":"string","format":"uri"}},"supportedDevices":{"type":"array","items":{"type":"string"}}}},"Pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}},"ErrorEnvelope":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/appstore/similar":{"get":{"operationId":"getSimilarApps","summary":"Get similar applications","description":"Returns applications similar to the supplied one. Provide exactly one of `appId` or `bundleId`.","tags":["appstore"],"parameters":[{"name":"appId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d{8,12}$"}},{"name":"bundleId","in":"query","required":false,"schema":{"type":"string","maxLength":255,"pattern":"^[A-Za-z0-9.]+$"}},{"name":"country","in":"query","required":false,"schema":{"type":"string","minLength":2,"maxLength":2}},{"name":"lang","in":"query","required":false,"schema":{"type":"string","pattern":"^[a-z]{2,3}(-[a-z]{2,3})?$"}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Application"}},"pricing":{"$ref":"#/components/schemas/Pricing"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```

## Get reviews for an application

> Returns reviews for one application. Provide exactly one of \`appId\` or \`bundleId\`. Use \`page\` for pagination or \`maxItems\` for a one-shot bulk pull (mutually exclusive).

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"appstore","description":"Apple App Store: app lookup, search, similar apps, reviews, developer apps."}],"servers":[{"url":"https://dashboard.pullbay.com/api"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Review":{"type":"object","properties":{"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"userName":{"type":"string"},"userUrl":{"type":"string","format":"uri"},"version":{"type":"string"},"score":{"type":"integer","minimum":1,"maximum":5},"title":{"type":"string"},"text":{"type":"string"},"url":{"type":"string","format":"uri"},"country":{"type":"string"}}},"Pagination":{"type":"object","properties":{"page":{"type":"integer","nullable":true},"hasNextPage":{"type":"boolean","nullable":true},"cursor":{"type":"string","nullable":true},"offset":{"type":"string","nullable":true,"description":"Numeric offset string for offset-paginated endpoints (e.g. Google Maps place search)."}}},"Pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}},"ErrorEnvelope":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/appstore/reviews":{"get":{"operationId":"getReviews","summary":"Get reviews for an application","description":"Returns reviews for one application. Provide exactly one of `appId` or `bundleId`. Use `page` for pagination or `maxItems` for a one-shot bulk pull (mutually exclusive).","tags":["appstore"],"parameters":[{"name":"appId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d{8,12}$"}},{"name":"bundleId","in":"query","required":false,"schema":{"type":"string","maxLength":255,"pattern":"^[A-Za-z0-9.]+$"}},{"name":"country","in":"query","required":false,"schema":{"type":"string","minLength":2,"maxLength":2}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["recent","helpful"]}},{"name":"maxItems","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":10}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Review"}},"pagination":{"$ref":"#/components/schemas/Pagination"},"pricing":{"$ref":"#/components/schemas/Pricing"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```

## Get all applications by a developer

> Returns the list of applications published by a single developer.

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"appstore","description":"Apple App Store: app lookup, search, similar apps, reviews, developer apps."}],"servers":[{"url":"https://dashboard.pullbay.com/api"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Application":{"type":"object","properties":{"id":{"type":"integer"},"appId":{"type":"string"},"title":{"type":"string"},"url":{"type":"string","format":"uri"},"description":{"type":"string"},"icon":{"type":"string","format":"uri"},"genres":{"type":"array","items":{"type":"string"}},"genreIds":{"type":"array","items":{"type":"string"}},"primaryGenre":{"type":"string"},"primaryGenreId":{"type":"integer"},"contentRating":{"type":"string"},"languages":{"type":"array","items":{"type":"string"}},"size":{"type":"string"},"requiredOsVersion":{"type":"string"},"released":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"releaseNotes":{"type":"string"},"version":{"type":"string"},"price":{"type":"number"},"currency":{"type":"string"},"free":{"type":"boolean"},"developerId":{"type":"integer"},"developer":{"type":"string"},"developerUrl":{"type":"string","format":"uri"},"developerWebsite":{"type":"string","format":"uri"},"score":{"type":"number"},"reviews":{"type":"integer"},"currentVersionScore":{"type":"number"},"currentVersionReviews":{"type":"integer"},"screenshots":{"type":"array","items":{"type":"string","format":"uri"}},"ipadScreenshots":{"type":"array","items":{"type":"string","format":"uri"}},"appletvScreenshots":{"type":"array","items":{"type":"string","format":"uri"}},"supportedDevices":{"type":"array","items":{"type":"string"}}}},"Pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}},"ErrorEnvelope":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/appstore/developer":{"get":{"operationId":"getDeveloperApps","summary":"Get all applications by a developer","description":"Returns the list of applications published by a single developer.","tags":["appstore"],"parameters":[{"name":"developerId","in":"query","required":true,"schema":{"type":"string","pattern":"^\\d{8,12}$"}},{"name":"country","in":"query","required":false,"schema":{"type":"string","minLength":2,"maxLength":2}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Application"}},"pricing":{"$ref":"#/components/schemas/Pricing"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.pullbay.com/api-reference/appstore.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
