MultiPass

See MultiPass in action on the demo site.

A MultiPass is a JSON object that represents an OP query. Any valid API request can be serialized as a MultiPass, and any MultiPass can be used to reconstruct the same request later — in a component, a feed, or your own code.

Getting a MultiPass

Add /multipass as the format segment of any API URL:

https://octothorp.es/get/pages/thorped/multipass?o=demo

The response is a MultiPass JSON object you can save, share, or pass to a component.

Shape

{
  "meta": {
    "title": "string",
    "description": "string",
    "server": "https://octothorp.es/",
    "author": "string",
    "image": "url",
    "version": "1",
    "resultMode": "blobjects | links | octothorpes | domains"
  },
  "subjects": {
    "mode": "exact | fuzzy | byParent",
    "include": [],
    "exclude": []
  },
  "objects": {
    "type": "termsOnly | pagesOnly | notTerms | all | none",
    "mode": "exact | fuzzy | very-fuzzy",
    "include": [],
    "exclude": []
  },
  "filters": {
    "subtype": "Backlink | Cite | Bookmark | null",
    "limitResults": "100",
    "offsetResults": "0",
    "dateRange": {
      "after": 1704067200,
      "before": 1735689600
    }
  }
}

Using a MultiPass in a component

Pass it as the multipass attribute on <octo-multipass>:

<script type="module" src="https://octothorp.es/components/octo-multipass.js"></script>
<octo-multipass multipass='{ ... }' autoload></octo-multipass>

MultiPass GIFs

A MultiPass can be embedded inside a GIF file. Drop a MultiPass GIF onto an <octo-multipass-loader> and it will extract the query and fetch results.

<script type="module" src="https://octothorp.es/components/octo-multipass-loader.js"></script>
<octo-multipass-loader></octo-multipass-loader>

You can also preload a GIF directly without the drop zone:

<octo-multipass-loader gif="https://yoursite.com/my-feed.gif" render="list"></octo-multipass-loader>

See Component reference for the full <octo-multipass> and <octo-multipass-loader> attribute reference.