at.happyproto.registry.getPackage Documentation (EN)

main query

One package by publisher and slug. A withdrawn package is still returned, flagged `deleted`, because its releases stay resolvable.

Parameters

actor string at-identifier Required

The publisher, as a DID or a handle. A handle is confirmed in both directions before it is accepted, so one pointed at another publisher's DID cannot show their packages under it.

slug string Required

The package slug, which is its profile's record key.

Output

Encodingapplication/json

Schemaat.happyproto.registry.defs#packageView

Errors

PackageNotFound No profile is indexed for that publisher and slug.

ActorNotFound actor is neither a DID nor a handle that resolves to one.

NotConfigured The registry instance has no identity configured (HAPPYPROTO_DID), so it cannot read its own state. An operator problem, not a caller's.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

actor * The publisher, as a DID or a handle. A handle is confirmed in both directions before it is accepted, so one pointed at another publisher's DID cannot show their packages under it.

slug * The package slug, which is its profile's record key.

View raw schema

{
  "description": "One package by publisher and slug. A withdrawn package is still returned, flagged `deleted`, because its releases stay resolvable.",
  "errors": [
    {
      "description": "No profile is indexed for that publisher and slug.",
      "name": "PackageNotFound"
    },
    {
      "description": "actor is neither a DID nor a handle that resolves to one.",
      "name": "ActorNotFound"
    },
    {
      "description": "The registry instance has no identity configured (HAPPYPROTO_DID), so it cannot read its own state. An operator problem, not a caller's.",
      "name": "NotConfigured"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "ref": "at.happyproto.registry.defs#packageView",
      "type": "ref"
    }
  },
  "parameters": {
    "properties": {
      "actor": {
        "description": "The publisher, as a DID or a handle. A handle is confirmed in both directions before it is accepted, so one pointed at another publisher's DID cannot show their packages under it.",
        "format": "at-identifier",
        "type": "string"
      },
      "slug": {
        "description": "The package slug, which is its profile's record key.",
        "type": "string"
      }
    },
    "required": [
      "actor",
      "slug"
    ],
    "type": "params"
  },
  "type": "query"
}