Canister logo
API Changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification

Topics

  • Introduction

Endpoints

  • endpoint
    • Health Check GET
    • Landing Page GET
    • OpenAPI JSON GET
    • OpenAPI YAML GET
  • lookup
    • Package Lookup GET
    • Multi Package Lookup GET
    • Repository Lookup GET
    • Repository Packages GET
    • Repository Safety Check GET
  • search
    • Package Search GET
    • Repository Rank Search GET
    • Repository Search GET
Powered by Bump.sh

Package Search

GET /jailbreak/package/search

Retrieve an indexed package using a search query

Query parameters

  • q string(query) Required

    The search query

    Minimum length is 2.

  • limit integer

    Search response limit

    Minimum value is 1, maximum value is 250. Default value is 100.

  • page integer

    Pagination number (starting from 1)

    Minimum value is 1. Default value is 1.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • message string

      Value is 200 Successful.

    • date string(date-time)
    • refs object
      Hide refs attributes Show refs attributes object
      • nextPage string(uri)
      • previousPage string(uri)
    • count integer

      Minimum value is 0.

    • data array[object]
      Hide data attributes Show data attributes object
      • quality number

        The quality of the package's hosting repository

      • refs object
        Hide refs attributes Show refs attributes object
        • meta string

          URL to the package metadata

        • repo string

          URL to the repository metadata

      • sha256_hash string | null

        SHA256 hash of the package

      • section string | null

        Package section

      • maintainer string | null

        Package maintainer

      • icon_url string

        URL to the package's icon

      • latest_version boolean

        If this is the latest version of the package

      • repository_id string

        The ID of the package's hosting repository

      • name string | null

        Package name

      • package string Deprecated

        Package identifier (legacy)

      • native_depiction string | null

        URL to the package's native depiction V2

      • repositoryTier number Deprecated

        Package repository tier (legacy)

      • description string | null

        Package description

      • package_id string

        Package identifier

      • package_size number

        Download size of the package in bytes

      • header_url string

        URL to the package's header image

      • package_filename string

        Filename of the package on the repository

      • tags array[string] | null

        Package tags

      • installed_size number | null

        Size of the package when installed in bytes

      • id string

        Database ID (Unique hash)

      • visible boolean

        If this package is visible

      • version string

        Package version

      • architecture string

        Supported architecture

      • author string | null

        Package author

      • price string

        Price of the package

      • repository object
        Hide repository attributes Show repository attributes object
        • suite string

          Debian APT suite

        • name string | null

          Repository name

        • description string | null

          Repository description

        • date string

          Repository last updated date

        • slug string Deprecated

          Repository slug (legacy)

        • uri string

          URL to the repository

        • origin_has_release_gpg boolean

          Repository has a Release.gpg file

        • quality number

          Quality of the repository

        • package_count number

          Number of packages in the repository

        • bootstrap boolean

          If the repository is a bootstrap repository

        • origin_has_in_release boolean

          Repository has an InRelease file

        • id string

          Repository identifier

        • visible boolean

          If the repository is visible

        • origin_release_path string

          Path to the repository Release file

        • origin_hostname string

          Hostname of the repository origin

        • origin_packages_hash string

          Hash of the repository Packages file

        • origin_uses_https boolean

          Repository uses HTTPS

        • tier number Deprecated

          Repository tier (legacy)

        • origin_last_updated string

          Last updated date of the repository origin

        • origin_supports_payment_v1 boolean

          Repository supports payment V1 (Sileo)

        • sections array[string]

          Repository sections

        • version string

          Repository version

        • origin_release_hash string

          Hash of the repository Release file

        • origin_packages_path string

          Path to the repository Packages file

        • origin_supports_payment_v2 boolean

          Repository supports payment V2 (Native)

        • isBootstrap boolean Deprecated

          If the repository is a bootstrap repository (legacy)

  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • error string

      The error message

    • message string

      The HTTP status code for the error

    • date string

      The date and time of the error

GET /jailbreak/package/search
curl \
 --request GET 'http://api.example.com/jailbreak/package/search?q=mypackage'
Response examples (200)
{
  "message": "200 Successful",
  "date": "2025-05-04T09:42:00Z",
  "refs": {
    "nextPage": "https://example.com",
    "previousPage": "https://example.com"
  },
  "count": 42,
  "data": [
    {
      "quality": 3,
      "refs": {
        "meta": "https://api.canister.me/v2/jailbreak/package/com.amywhile.aemulo",
        "repo": "https://api.canister.me/v2/jailbreak/repository/amy"
      },
      "sha256_hash": "35f8a73d59da76bd391d721fba9600d0a2380df63371a6c6c4db5d4ff06ce2a8",
      "section": "Tweaks",
      "maintainer": "Amy While <support@anamy.gay>",
      "icon_url": "https://elihwyma.github.io/Aemulo/assets/Icon.png",
      "latest_version": true,
      "repository_id": "amy",
      "name": "Aemulo",
      "package": "com.amywhile.aemulo",
      "native_depiction": "https://elihwyma.github.io/Aemulo/NativeDepiction.json",
      "repositoryTier": 3,
      "description": "NFC Frickery",
      "package_id": "com.amywhile.aemulo",
      "package_size": 487530,
      "header_url": "https://elihwyma.github.io/Aemulo/assets/Depiction-Header.png",
      "package_filename": "./pool/com.amywhile.aemulo_2.0-82b9fb9_iphoneos-arm.deb",
      "tags": [
        "string"
      ],
      "installed_size": 1720,
      "id": "fda6e5fd8385fd2aa6409dad55395739d9f8ccfccfc900bfdfb97692a9b279e6",
      "visible": true,
      "version": "2.0-82b9fb9",
      "architecture": "iphoneos-arm",
      "author": "Amy While <support@anamy.gay>",
      "price": "Free",
      "repository": {
        "suite": "./",
        "name": "Amy's Repo",
        "description": "Amy's Dump of Tweaks",
        "date": "2024-06-12T16:00:18+00:00",
        "slug": "amy",
        "uri": "https://repo.anamy.gay",
        "origin_has_release_gpg": true,
        "quality": 3,
        "package_count": 0,
        "bootstrap": false,
        "origin_has_in_release": false,
        "id": "amy",
        "visible": true,
        "origin_release_path": "/Release",
        "origin_hostname": "repo.anamy.gay",
        "origin_packages_hash": "976342039c0c4c0ff1d2010ad66bb59dc49344f8ed7a468e360600dd42915297",
        "origin_uses_https": true,
        "tier": 3,
        "origin_last_updated": "2024-07-24T03:04:08+00:00",
        "origin_supports_payment_v1": false,
        "sections": [
          "string"
        ],
        "version": "1.0",
        "origin_release_hash": "1f7530bde853c58e89480203455795e6202e699906fd59c55c95d11ab06906c3",
        "origin_packages_path": "/Packages.zst",
        "origin_supports_payment_v2": false,
        "isBootstrap": false
      }
    }
  ]
}
Response examples (400)
{
  "error": "Missing query parameter: 'q'",
  "message": "400 Bad Request",
  "date": "2023-01-04T20: 34: 05.627525+00: 00"
}