{"openapi":"3.1.0","info":{"title":"Apizie: application","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/application:app-store/app":{"get":{"operationId":"application_app_store_app","summary":"App","description":"App details by App Store id or bundle id.","tags":["application"],"parameters":[{"name":"id","in":"query","required":false,"schema":{"type":"string"},"example":"284882215"},{"name":"bundleId","in":"query","required":false,"schema":{"type":"string"},"example":"com.facebook.Facebook"},{"name":"country","in":"query","required":false,"description":"Two-letter storefront country code","schema":{"type":"string","default":"us","description":"Two-letter storefront country code"},"example":"us"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/application:app-store/search":{"get":{"operationId":"application_app_store_search","summary":"Search","description":"Search the App Store.","tags":["application"],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":"photo editor"},{"name":"country","in":"query","required":false,"description":"Two-letter storefront country code","schema":{"type":"string","default":"us","description":"Two-letter storefront country code"},"example":"us"},{"name":"entity","in":"query","required":false,"schema":{"type":"string","enum":["software","iPadSoftware","macSoftware","tvSoftware"],"default":"software"}},{"name":"page","in":"query","required":false,"description":"1-based page number","schema":{"type":"integer","default":1,"minimum":1,"maximum":20,"description":"1-based page number"}},{"name":"count","in":"query","required":false,"description":"Items per page","schema":{"type":"integer","default":25,"minimum":1,"maximum":200,"description":"Items per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/application:app-store/developer":{"get":{"operationId":"application_app_store_developer","summary":"Developer","description":"All apps published by a developer (artist) id.","tags":["application"],"parameters":[{"name":"developerId","in":"query","required":true,"schema":{"type":"string"},"example":"284882218"},{"name":"country","in":"query","required":false,"description":"Two-letter storefront country code","schema":{"type":"string","default":"us","description":"Two-letter storefront country code"},"example":"us"},{"name":"entity","in":"query","required":false,"schema":{"type":"string","enum":["software","iPadSoftware","macSoftware","tvSoftware"],"default":"software"}},{"name":"count","in":"query","required":false,"description":"Items per page","schema":{"type":"integer","default":50,"minimum":1,"maximum":200,"description":"Items per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/application:app-store/reviews":{"get":{"operationId":"application_app_store_reviews","summary":"Reviews","description":"Customer reviews from Apple's review RSS feed (up to 10 pages of 50).","tags":["application"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"},"example":"284882215"},{"name":"country","in":"query","required":false,"description":"Two-letter storefront country code","schema":{"type":"string","default":"us","description":"Two-letter storefront country code"},"example":"us"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["mostrecent","mosthelpful"],"default":"mostrecent"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"minimum":1,"maximum":10}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":1800,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/application:app-store/charts":{"get":{"operationId":"application_app_store_charts","summary":"Top Charts","description":"App Store top charts (free, paid, grossing, iPad, new) per country, optionally per genre id.","tags":["application"],"parameters":[{"name":"feed","in":"query","required":false,"schema":{"type":"string","enum":["topfreeapplications","toppaidapplications","topgrossingapplications","topfreeipadapplications","toppaidipadapplications","topgrossingipadapplications","newapplications","newfreeapplications","newpaidapplications"],"default":"topfreeapplications"}},{"name":"country","in":"query","required":false,"description":"Two-letter storefront country code","schema":{"type":"string","default":"us","description":"Two-letter storefront country code"},"example":"us"},{"name":"genre","in":"query","required":false,"description":"App Store genre id, e.g. 6014 = Games","schema":{"type":"string","description":"App Store genre id, e.g. 6014 = Games"},"example":"6014"},{"name":"count","in":"query","required":false,"description":"Items per page","schema":{"type":"integer","default":50,"minimum":1,"maximum":200,"description":"Items per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":1800,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/application:firefox-addons/addon":{"get":{"operationId":"application_firefox_addons_addon","summary":"Add-on","description":"Add-on details by numeric id, slug or GUID.","tags":["application"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"},"example":"ublock-origin"},{"name":"lang","in":"query","required":false,"schema":{"type":"string","default":"en-US"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/application:firefox-addons/search":{"get":{"operationId":"application_firefox_addons_search","summary":"Search","description":"Search add-ons.","tags":["application"],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":"password manager"},{"name":"app","in":"query","required":false,"schema":{"type":"string","enum":["firefox","android"],"default":"firefox"}},{"name":"type","in":"query","required":false,"schema":{"type":"string","enum":["extension","theme","dictionary","language","statictheme"]}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["relevance","users","rating","created","updated","downloads","hotness","random"]}},{"name":"lang","in":"query","required":false,"schema":{"type":"string","default":"en-US"}},{"name":"page","in":"query","required":false,"description":"1-based page number","schema":{"type":"integer","default":1,"minimum":1,"maximum":100,"description":"1-based page number"}},{"name":"count","in":"query","required":false,"description":"Items per page","schema":{"type":"integer","default":25,"minimum":1,"maximum":50,"description":"Items per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/application:firefox-addons/versions":{"get":{"operationId":"application_firefox_addons_versions","summary":"Versions","description":"Published versions of an add-on.","tags":["application"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"},"example":"ublock-origin"},{"name":"lang","in":"query","required":false,"schema":{"type":"string","default":"en-US"}},{"name":"page","in":"query","required":false,"description":"1-based page number","schema":{"type":"integer","default":1,"minimum":1,"maximum":100,"description":"1-based page number"}},{"name":"count","in":"query","required":false,"description":"Items per page","schema":{"type":"integer","default":25,"minimum":1,"maximum":50,"description":"Items per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/application:firefox-addons/reviews":{"get":{"operationId":"application_firefox_addons_reviews","summary":"Reviews","description":"User ratings and reviews of an add-on.","tags":["application"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"},"example":"ublock-origin"},{"name":"score","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":5}},{"name":"lang","in":"query","required":false,"schema":{"type":"string","default":"en-US"}},{"name":"page","in":"query","required":false,"description":"1-based page number","schema":{"type":"integer","default":1,"minimum":1,"maximum":100,"description":"1-based page number"}},{"name":"count","in":"query","required":false,"description":"Items per page","schema":{"type":"integer","default":25,"minimum":1,"maximum":50,"description":"Items per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":1800,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/application:firefox-addons/author":{"get":{"operationId":"application_firefox_addons_author","summary":"Author","description":"Public profile of an add-on developer plus their add-ons.","tags":["application"],"parameters":[{"name":"developer","in":"query","required":true,"description":"User id or username","schema":{"type":"string","description":"User id or username"},"example":"gorhill"},{"name":"lang","in":"query","required":false,"schema":{"type":"string","default":"en-US"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/application:snapcraft/snap":{"get":{"operationId":"application_snapcraft_snap","summary":"Snap","description":"Details and channel map of a snap by name.","tags":["application"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"},"example":"firefox"},{"name":"architecture","in":"query","required":false,"schema":{"type":"string"},"example":"amd64"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/application:snapcraft/search":{"get":{"operationId":"application_snapcraft_search","summary":"Search","description":"Search the Snap Store.","tags":["application"],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":"vlc"},{"name":"page","in":"query","required":false,"description":"1-based page number","schema":{"type":"integer","default":1,"minimum":1,"maximum":100,"description":"1-based page number"}},{"name":"count","in":"query","required":false,"description":"Items per page","schema":{"type":"integer","default":20,"minimum":1,"maximum":100,"description":"Items per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/application:flathub/app":{"get":{"operationId":"application_flathub_app","summary":"App","description":"AppStream metadata of an app by its Flatpak id.","tags":["application"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"},"example":"org.mozilla.firefox"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/application:flathub/collection":{"get":{"operationId":"application_flathub_collection","summary":"Collection","description":"Curated Flathub lists (popular, trending, new, updated, verified, mobile).","tags":["application"],"parameters":[{"name":"collection","in":"query","required":false,"schema":{"type":"string","enum":["popular","recently-added","recently-updated","trending","verified","mobile"],"default":"popular"}},{"name":"page","in":"query","required":false,"description":"1-based page number","schema":{"type":"integer","default":1,"minimum":1,"maximum":100,"description":"1-based page number"}},{"name":"count","in":"query","required":false,"description":"Items per page","schema":{"type":"integer","default":25,"minimum":1,"maximum":250,"description":"Items per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/application:flathub/stats":{"get":{"operationId":"application_flathub_stats","summary":"Install Stats","description":"Install statistics of an app.","tags":["application"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"},"example":"org.mozilla.firefox"},{"name":"days","in":"query","required":false,"description":"How many daily points to return","schema":{"type":"integer","default":30,"minimum":1,"maximum":3650,"description":"How many daily points to return"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/application:flathub/search":{"get":{"operationId":"application_flathub_search","summary":"Search","description":"Search Flathub apps.","tags":["application"],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":"image editor"},{"name":"page","in":"query","required":false,"description":"1-based page number","schema":{"type":"integer","default":1,"minimum":1,"maximum":100,"description":"1-based page number"}},{"name":"count","in":"query","required":false,"description":"Items per page","schema":{"type":"integer","default":25,"minimum":1,"maximum":250,"description":"Items per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}