fyi.atstore.directory.getListing

Documentation

Fetch one public verified listing. Provide exactly one of `uri` (fyi.atstore.listing.detail AT URI) or `externalUrl` (unique storefront URL); `externalUrl` uses the same matching rules as the former resolve endpoint.

main query

Parameters

externalUrl string Optional

Listing external_url / product URL as stored on the record; must match at most one public listing.

uri string at-uri Optional

AT URI of the fyi.atstore.listing.detail record.

Output

Encodingapplication/json

Schema#listingDetailResponse

Errors

ListingNotFound

InvalidParams

AmbiguousResolution

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

externalUrl Listing external_url / product URL as stored on the record; must match at most one public listing.

uri AT URI of the fyi.atstore.listing.detail record.

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "ListingNotFound"
    },
    {
      "name": "InvalidParams"
    },
    {
      "name": "AmbiguousResolution"
    }
  ],
  "output": {
    "schema": {
      "ref": "#listingDetailResponse",
      "type": "ref"
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "uri": {
        "type": "string",
        "format": "at-uri",
        "maxLength": 2560,
        "description": "AT URI of the fyi.atstore.listing.detail record."
      },
      "externalUrl": {
        "type": "string",
        "maxLength": 2048,
        "description": "Listing external_url / product URL as stored on the record; must match at most one public listing."
      }
    }
  },
  "description": "Fetch one public verified listing. Provide exactly one of `uri` (fyi.atstore.listing.detail AT URI) or `externalUrl` (unique storefront URL); `externalUrl` uses the same matching rules as the former resolve endpoint."
}

listingCardGet object

No description available.

Properties

accent string Required

No description available.

maxLength: 16 bytes

Known values: blue, pink, purple, green

appTags array of string Required

No description available.

category string Required

No description available.

maxLength: 640 bytes

categorySlug string Optional

No description available.

maxLength: 512 bytes

categorySlugs array of string Required

No description available.

description string Required

No description available.

maxLength: 20000 bytes

heroImageUrl string Optional

No description available.

maxLength: 8192 bytes

iconUrl string Optional

No description available.

maxLength: 8192 bytes

name string Required

No description available.

maxLength: 640 bytes

priceLabel string Required

No description available.

maxLength: 32 bytes

productAccountHandle string Optional

No description available.

maxLength: 512 bytes

rating string Optional

No description available.

maxLength: 16 bytes

reviewCount integer Required

No description available.

tagline string Required

No description available.

maxLength: 2000 bytes

uri string at-uri Required

AT URI of the fyi.atstore.listing.detail record.

maxLength: 2560 bytes

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "name",
    "tagline",
    "description",
    "category",
    "accent",
    "reviewCount",
    "priceLabel",
    "appTags",
    "categorySlugs"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri",
      "maxLength": 2560,
      "description": "AT URI of the fyi.atstore.listing.detail record."
    },
    "name": {
      "type": "string",
      "maxLength": 640
    },
    "accent": {
      "type": "string",
      "maxLength": 16,
      "knownValues": [
        "blue",
        "pink",
        "purple",
        "green"
      ]
    },
    "rating": {
      "type": "string",
      "nullable": true,
      "maxLength": 16
    },
    "appTags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 256
      }
    },
    "iconUrl": {
      "type": "string",
      "nullable": true,
      "maxLength": 8192
    },
    "tagline": {
      "type": "string",
      "maxLength": 2000
    },
    "category": {
      "type": "string",
      "maxLength": 640
    },
    "priceLabel": {
      "type": "string",
      "maxLength": 32
    },
    "description": {
      "type": "string",
      "maxLength": 20000
    },
    "reviewCount": {
      "type": "integer"
    },
    "categorySlug": {
      "type": "string",
      "nullable": true,
      "maxLength": 512
    },
    "heroImageUrl": {
      "type": "string",
      "nullable": true,
      "maxLength": 8192
    },
    "categorySlugs": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 512
      }
    },
    "productAccountHandle": {
      "type": "string",
      "nullable": true,
      "maxLength": 512
    }
  }
}

listingDetailResponse object

No description available.

Properties

createdAt string Optional

No description available.

maxLength: 64 bytes

externalUrl string Optional

No description available.

maxLength: 2048 bytes

isStoreManaged boolean Required

No description available.

links array of ref#listingLinkRow Optional

No description available.

listing ref #listingCardGet Required

No description available.

productAccountDid string Optional

No description available.

maxLength: 2048 bytes

repoDid string Optional

No description available.

maxLength: 2048 bytes

screenshots array of string Optional

No description available.

sourceFullDescription string Optional

No description available.

maxLength: 20000 bytes

sourceTagline string Optional

No description available.

maxLength: 20000 bytes

sourceUrl string Optional

No description available.

maxLength: 8192 bytes

updatedAt string Optional

No description available.

maxLength: 64 bytes

View raw schema

{
  "type": "object",
  "required": [
    "listing",
    "isStoreManaged"
  ],
  "properties": {
    "links": {
      "type": "array",
      "items": {
        "ref": "#listingLinkRow",
        "type": "ref"
      }
    },
    "listing": {
      "ref": "#listingCardGet",
      "type": "ref"
    },
    "repoDid": {
      "type": "string",
      "nullable": true,
      "maxLength": 2048
    },
    "createdAt": {
      "type": "string",
      "nullable": true,
      "maxLength": 64
    },
    "sourceUrl": {
      "type": "string",
      "nullable": true,
      "maxLength": 8192
    },
    "updatedAt": {
      "type": "string",
      "nullable": true,
      "maxLength": 64
    },
    "externalUrl": {
      "type": "string",
      "nullable": true,
      "maxLength": 2048
    },
    "screenshots": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 4096
      }
    },
    "sourceTagline": {
      "type": "string",
      "nullable": true,
      "maxLength": 20000
    },
    "isStoreManaged": {
      "type": "boolean"
    },
    "productAccountDid": {
      "type": "string",
      "nullable": true,
      "maxLength": 2048
    },
    "sourceFullDescription": {
      "type": "string",
      "nullable": true,
      "maxLength": 20000
    }
  }
}

listingLinkRow object

No description available.

Properties

label string Optional

No description available.

maxLength: 640 bytes

uri string Required

No description available.

maxLength: 2048 bytes

View raw schema

{
  "type": "object",
  "required": [
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "maxLength": 2048
    },
    "label": {
      "type": "string",
      "maxLength": 640
    }
  }
}