Urbit Developers
  • Hoon

    • Overview
    • Cheat Sheet
    • Irregular forms
    • Hoon Errors
    • Hoon Style Guide
    • Basic Types
    • Advanced Types
    • Auras
    • Standard Library

      • 1a: Basic Arithmetic
      • 1b: Tree Addressing
      • 1c: Molds and Mold-Builders
      • 2a: Unit Logic
      • 2b: List Logic
      • 2c: Bit Arithmetic
      • 2d: Bit Logic
      • 2e: Insecure Hashing
      • 2f: Noun Ordering
      • 2g: Unsigned Powers
      • 2h: Set Logic
      • 2i: Map Logic
      • 2j: Jar and Jug Logic
      • 2k: Queue Logic
      • 2l: Container from Container
      • 2m: Container from Noun
      • 2n: Functional Hacks
      • 2o: Normalizing Containers
      • 2p: Serialization
      • 2q: Molds and Mold-Builders
      • 3a: Modular and Signed Ints
      • 3b: Floating Point
      • 3c: Urbit Time
      • 3d: SHA Hash Family
      • 3e: AES encryption (Removed)
      • 3f: Scrambling
      • 3g: Molds and Mold-Builders
      • 4a: Exotic Bases
      • 4b: Text Processing
      • 4c: Tank Printer
      • 4d: Parsing (Tracing)
      • 4e: Parsing (Combinators)
      • 4f: Parsing (Rule-Builders)
      • 4g: Parsing (Outside Caller)
      • 4h: Parsing (ASCII Glyphs)
      • 4i: Parsing (Useful Idioms)
      • 4j: Parsing (Bases and Base Digits)
      • 4k: Atom Printing
      • 4l: Atom Parsing
      • 4m: Formatting Functions
      • 4n: Virtualization
      • 4o: Molds
      • 5a: Compiler Utilities
      • 5b: Macro Expansion
      • 5c: Compiler Backend & Prettyprinter
      • 5d: Parser
      • 5e: Molds and mold builders
      • 5f: Profiling support
      • Runes

        • Atoms and strings
        • Nock . ('dot')
        • Wild ! ('zap')
        • Change Subject = ('tis')
        • Conditionals ? ('wut')
        • Cores | ('bar')
        • Arms + ('lus')
        • Cells : ('col')
        • Calls % ('cen')
        • Casts ^ ('ket')
        • Structures $ ('buc')
        • Make ; ('mic')
        • Hints ~ ('sig')
        • Imports / ('fas')
        • Terminators -- and ==
        • Limbs and wings

          • Limbs
          • Wings
          • Zuse

            • Table of Contents
            • 2d(1-5): To JSON, Wains
            • 2d(6): From JSON
            • 2d(7): From JSON (unit)
            • 2e(2-3): Print & Parse JSON
          • Arvo

            • Overview
            • Ames

              • Overview
              • Cryptography
              • API Reference
              • Scry Reference
              • Data Types
              • Behn

                • Overview
                • API Reference
                • Scry Reference
                • Examples
                • Clay

                  • Overview
                  • Architecture
                  • Using Clay
                  • Data Types
                  • Scry Reference
                  • API Reference
                  • Examples
                  • Marks

                    • Overview
                    • Writing Marks
                    • Using Marks
                    • Examples
                  • Dill

                    • Overview
                    • API Reference
                    • Scry Reference
                    • Data Types
                    • Eyre

                      • Overview
                      • External API Reference
                      • Internal API Reference
                      • Scry Reference
                      • Data Types
                      • Guide
                      • Gall

                        • Overview
                        • API Reference
                        • Data Types
                        • Threads Reference
                        • Iris

                          • Overview
                          • API Reference
                          • Data Types
                          • Example
                          • Jael

                            • Overview
                            • API Reference
                            • Scry Reference
                            • Data Types
                            • Examples
                            • Threads

                              • Overview
                              • HTTP API
                              • Reference
                              • Gall

                                • Start Thread
                                • Take Result
                                • Take Facts
                                • Stop Thread
                                • Poke Thread
                                • Examples

                                  • Fetch JSON
                                  • Child Thread
                                  • Main-loop
                                  • Poke Agent
                                  • Scry
                                  • Take Fact
                                • Concepts

                                  • Scries
                                  • Subscriptions
                                  • Tutorials

                                    • Move Trace
                                    • Reference

                                      • Cryptography
                                      • Filesystem Hierarchy
                                    • Nock

                                      • Nock Definition
                                      • Explanation
                                      • Example
                                      • Implementations
                                      • Vere

                                        • C Runtime System
                                        • Land of Nouns
                                        • API overview by prefix
                                        • C in Urbit
                                        • Writing Jets
                                        • Cryptography
                                        • Azimuth

                                          • Overview
                                          • Urbit HD Wallet
                                          • Azimuth Data Flow
                                          • Azimuth.eth
                                          • Ecliptic.eth
                                          • Advanced Azimuth Tools
                                          • Life and Rift
                                          • Layer 2

                                            • Layer 2 Overview
                                            • Layer 2 Actions
                                            • Transaction Format
                                            • Rollers
                                            • Roller HTTP RPC-API
                                            • Custom Roller Tutorial
                                          • Glossary

                                            • Agent
                                            • Ames
                                            • API
                                            • Aqua
                                            • Arm
                                            • Arvo
                                            • Atom
                                            • Aura
                                            • Aural ASCII
                                            • Azimuth
                                            • Battery
                                            • Behn
                                            • Bowl
                                            • Bridge
                                            • Bunt
                                            • Card
                                            • Case
                                            • Cask
                                            • Cell
                                            • Censures
                                            • Claims
                                            • Clay
                                            • Cold atom
                                            • Comet
                                            • Commit
                                            • Cons
                                            • Context
                                            • Cord
                                            • Core
                                            • Delegated Sending
                                            • Desk
                                            • Dill
                                            • Document Proposal
                                            • Dojo
                                            • Door
                                            • Double-boot
                                            • Dry Gate
                                            • Duct
                                            • Ecliptic
                                            • Entropy
                                            • Event Log
                                            • Eyre
                                            • Face
                                            • Fact
                                            • Foo Bar Baz
                                            • Galaxy
                                            • Gall
                                            • Garden
                                            • Gate
                                            • Generator
                                            • Gift
                                            • Glob
                                            • HD Wallet
                                            • Helm
                                            • Hood
                                            • Hoon
                                            • Invite Tree
                                            • Iris
                                            • Jael
                                            • Jet
                                            • Kelvin versioning
                                            • Kelvin versioning
                                            • Keyfile
                                            • Keywords
                                            • Khan
                                            • Kiln
                                            • Landscape
                                            • Leg
                                            • List
                                            • Loobean
                                            • Lull
                                            • Mark
                                            • Metals
                                            • Mold
                                            • Monad
                                            • Moon
                                            • Move
                                            • Nock
                                            • Noun
                                            • ~
                                            • OTA Updates
                                            • Path Prefix
                                            • Path
                                            • @p
                                            • Payload
                                            • Peek
                                            • pH
                                            • Pier
                                            • Pill
                                            • Planet
                                            • Poke
                                            • Proxies
                                            • Replay
                                            • Factory Reset
                                            • Roller
                                            • Naive rollups
                                            • Rune
                                            • Runtime
                                            • Sail
                                            • Sample
                                            • Scry
                                            • Senate
                                            • Ship
                                            • Slam
                                            • Spider
                                            • Star
                                            • String
                                            • Subject Oriented Programming
                                            • Subject
                                            • Subscription
                                            • Tape
                                            • Thread
                                            • Trap
                                            • Udon
                                            • Upgrade Proposal
                                            • Userspace
                                            • Vane
                                            • Vere
                                            • Voting
                                            • Warm atom
                                            • Wet Gate
                                            • Wing
                                            • Wire
                                            • Wrapper
                                            • ~zod
                                            • Zuse
                                            • Additional

                                              • Cryptography
                                              • Software Distribution

                                                • Overview
                                                • Docket File
                                                • Glob
                                                • Beacon

                                                  • Overview
                                                  • Subscriptions
                                                  • Scry Paths
                                                  • Types
                                                Urbit Developers
                                                • Hoon

                                                  • Overview
                                                  • Cheat Sheet
                                                  • Irregular forms
                                                  • Hoon Errors
                                                  • Hoon Style Guide
                                                  • Basic Types
                                                  • Advanced Types
                                                  • Auras
                                                  • Standard Library

                                                    • 1a: Basic Arithmetic
                                                    • 1b: Tree Addressing
                                                    • 1c: Molds and Mold-Builders
                                                    • 2a: Unit Logic
                                                    • 2b: List Logic
                                                    • 2c: Bit Arithmetic
                                                    • 2d: Bit Logic
                                                    • 2e: Insecure Hashing
                                                    • 2f: Noun Ordering
                                                    • 2g: Unsigned Powers
                                                    • 2h: Set Logic
                                                    • 2i: Map Logic
                                                    • 2j: Jar and Jug Logic
                                                    • 2k: Queue Logic
                                                    • 2l: Container from Container
                                                    • 2m: Container from Noun
                                                    • 2n: Functional Hacks
                                                    • 2o: Normalizing Containers
                                                    • 2p: Serialization
                                                    • 2q: Molds and Mold-Builders
                                                    • 3a: Modular and Signed Ints
                                                    • 3b: Floating Point
                                                    • 3c: Urbit Time
                                                    • 3d: SHA Hash Family
                                                    • 3e: AES encryption (Removed)
                                                    • 3f: Scrambling
                                                    • 3g: Molds and Mold-Builders
                                                    • 4a: Exotic Bases
                                                    • 4b: Text Processing
                                                    • 4c: Tank Printer
                                                    • 4d: Parsing (Tracing)
                                                    • 4e: Parsing (Combinators)
                                                    • 4f: Parsing (Rule-Builders)
                                                    • 4g: Parsing (Outside Caller)
                                                    • 4h: Parsing (ASCII Glyphs)
                                                    • 4i: Parsing (Useful Idioms)
                                                    • 4j: Parsing (Bases and Base Digits)
                                                    • 4k: Atom Printing
                                                    • 4l: Atom Parsing
                                                    • 4m: Formatting Functions
                                                    • 4n: Virtualization
                                                    • 4o: Molds
                                                    • 5a: Compiler Utilities
                                                    • 5b: Macro Expansion
                                                    • 5c: Compiler Backend & Prettyprinter
                                                    • 5d: Parser
                                                    • 5e: Molds and mold builders
                                                    • 5f: Profiling support
                                                    • Runes

                                                      • Atoms and strings
                                                      • Nock . ('dot')
                                                      • Wild ! ('zap')
                                                      • Change Subject = ('tis')
                                                      • Conditionals ? ('wut')
                                                      • Cores | ('bar')
                                                      • Arms + ('lus')
                                                      • Cells : ('col')
                                                      • Calls % ('cen')
                                                      • Casts ^ ('ket')
                                                      • Structures $ ('buc')
                                                      • Make ; ('mic')
                                                      • Hints ~ ('sig')
                                                      • Imports / ('fas')
                                                      • Terminators -- and ==
                                                      • Limbs and wings

                                                        • Limbs
                                                        • Wings
                                                        • Zuse

                                                          • Table of Contents
                                                          • 2d(1-5): To JSON, Wains
                                                          • 2d(6): From JSON
                                                          • 2d(7): From JSON (unit)
                                                          • 2e(2-3): Print & Parse JSON
                                                        • Arvo

                                                          • Overview
                                                          • Ames

                                                            • Overview
                                                            • Cryptography
                                                            • API Reference
                                                            • Scry Reference
                                                            • Data Types
                                                            • Behn

                                                              • Overview
                                                              • API Reference
                                                              • Scry Reference
                                                              • Examples
                                                              • Clay

                                                                • Overview
                                                                • Architecture
                                                                • Using Clay
                                                                • Data Types
                                                                • Scry Reference
                                                                • API Reference
                                                                • Examples
                                                                • Marks

                                                                  • Overview
                                                                  • Writing Marks
                                                                  • Using Marks
                                                                  • Examples
                                                                • Dill

                                                                  • Overview
                                                                  • API Reference
                                                                  • Scry Reference
                                                                  • Data Types
                                                                  • Eyre

                                                                    • Overview
                                                                    • External API Reference
                                                                    • Internal API Reference
                                                                    • Scry Reference
                                                                    • Data Types
                                                                    • Guide
                                                                    • Gall

                                                                      • Overview
                                                                      • API Reference
                                                                      • Data Types
                                                                      • Threads Reference
                                                                      • Iris

                                                                        • Overview
                                                                        • API Reference
                                                                        • Data Types
                                                                        • Example
                                                                        • Jael

                                                                          • Overview
                                                                          • API Reference
                                                                          • Scry Reference
                                                                          • Data Types
                                                                          • Examples
                                                                          • Threads

                                                                            • Overview
                                                                            • HTTP API
                                                                            • Reference
                                                                            • Gall

                                                                              • Start Thread
                                                                              • Take Result
                                                                              • Take Facts
                                                                              • Stop Thread
                                                                              • Poke Thread
                                                                              • Examples

                                                                                • Fetch JSON
                                                                                • Child Thread
                                                                                • Main-loop
                                                                                • Poke Agent
                                                                                • Scry
                                                                                • Take Fact
                                                                              • Concepts

                                                                                • Scries
                                                                                • Subscriptions
                                                                                • Tutorials

                                                                                  • Move Trace
                                                                                  • Reference

                                                                                    • Cryptography
                                                                                    • Filesystem Hierarchy
                                                                                  • Nock

                                                                                    • Nock Definition
                                                                                    • Explanation
                                                                                    • Example
                                                                                    • Implementations
                                                                                    • Vere

                                                                                      • C Runtime System
                                                                                      • Land of Nouns
                                                                                      • API overview by prefix
                                                                                      • C in Urbit
                                                                                      • Writing Jets
                                                                                      • Cryptography
                                                                                      • Azimuth

                                                                                        • Overview
                                                                                        • Urbit HD Wallet
                                                                                        • Azimuth Data Flow
                                                                                        • Azimuth.eth
                                                                                        • Ecliptic.eth
                                                                                        • Advanced Azimuth Tools
                                                                                        • Life and Rift
                                                                                        • Layer 2

                                                                                          • Layer 2 Overview
                                                                                          • Layer 2 Actions
                                                                                          • Transaction Format
                                                                                          • Rollers
                                                                                          • Roller HTTP RPC-API
                                                                                          • Custom Roller Tutorial
                                                                                        • Glossary

                                                                                          • Agent
                                                                                          • Ames
                                                                                          • API
                                                                                          • Aqua
                                                                                          • Arm
                                                                                          • Arvo
                                                                                          • Atom
                                                                                          • Aura
                                                                                          • Aural ASCII
                                                                                          • Azimuth
                                                                                          • Battery
                                                                                          • Behn
                                                                                          • Bowl
                                                                                          • Bridge
                                                                                          • Bunt
                                                                                          • Card
                                                                                          • Case
                                                                                          • Cask
                                                                                          • Cell
                                                                                          • Censures
                                                                                          • Claims
                                                                                          • Clay
                                                                                          • Cold atom
                                                                                          • Comet
                                                                                          • Commit
                                                                                          • Cons
                                                                                          • Context
                                                                                          • Cord
                                                                                          • Core
                                                                                          • Delegated Sending
                                                                                          • Desk
                                                                                          • Dill
                                                                                          • Document Proposal
                                                                                          • Dojo
                                                                                          • Door
                                                                                          • Double-boot
                                                                                          • Dry Gate
                                                                                          • Duct
                                                                                          • Ecliptic
                                                                                          • Entropy
                                                                                          • Event Log
                                                                                          • Eyre
                                                                                          • Face
                                                                                          • Fact
                                                                                          • Foo Bar Baz
                                                                                          • Galaxy
                                                                                          • Gall
                                                                                          • Garden
                                                                                          • Gate
                                                                                          • Generator
                                                                                          • Gift
                                                                                          • Glob
                                                                                          • HD Wallet
                                                                                          • Helm
                                                                                          • Hood
                                                                                          • Hoon
                                                                                          • Invite Tree
                                                                                          • Iris
                                                                                          • Jael
                                                                                          • Jet
                                                                                          • Kelvin versioning
                                                                                          • Kelvin versioning
                                                                                          • Keyfile
                                                                                          • Keywords
                                                                                          • Khan
                                                                                          • Kiln
                                                                                          • Landscape
                                                                                          • Leg
                                                                                          • List
                                                                                          • Loobean
                                                                                          • Lull
                                                                                          • Mark
                                                                                          • Metals
                                                                                          • Mold
                                                                                          • Monad
                                                                                          • Moon
                                                                                          • Move
                                                                                          • Nock
                                                                                          • Noun
                                                                                          • ~
                                                                                          • OTA Updates
                                                                                          • Path Prefix
                                                                                          • Path
                                                                                          • @p
                                                                                          • Payload
                                                                                          • Peek
                                                                                          • pH
                                                                                          • Pier
                                                                                          • Pill
                                                                                          • Planet
                                                                                          • Poke
                                                                                          • Proxies
                                                                                          • Replay
                                                                                          • Factory Reset
                                                                                          • Roller
                                                                                          • Naive rollups
                                                                                          • Rune
                                                                                          • Runtime
                                                                                          • Sail
                                                                                          • Sample
                                                                                          • Scry
                                                                                          • Senate
                                                                                          • Ship
                                                                                          • Slam
                                                                                          • Spider
                                                                                          • Star
                                                                                          • String
                                                                                          • Subject Oriented Programming
                                                                                          • Subject
                                                                                          • Subscription
                                                                                          • Tape
                                                                                          • Thread
                                                                                          • Trap
                                                                                          • Udon
                                                                                          • Upgrade Proposal
                                                                                          • Userspace
                                                                                          • Vane
                                                                                          • Vere
                                                                                          • Voting
                                                                                          • Warm atom
                                                                                          • Wet Gate
                                                                                          • Wing
                                                                                          • Wire
                                                                                          • Wrapper
                                                                                          • ~zod
                                                                                          • Zuse
                                                                                          • Additional

                                                                                            • Cryptography
                                                                                            • Software Distribution

                                                                                              • Overview
                                                                                              • Docket File
                                                                                              • Glob
                                                                                              • Beacon

                                                                                                • Overview
                                                                                                • Subscriptions
                                                                                                • Scry Paths
                                                                                                • Types
                                                                                              Reference/Additional/Beacon

                                                                                              Scry Paths

                                                                                              Below are all the scry paths you can query. All paths are %x scries.

                                                                                              /proof/[turf]

                                                                                              Make a proof for the given turf (domain). This is put in a manifest and published at <domain>/.well-known/appspecific/org.urbit.beacon.json. Sentinel uses it to validate requests.

                                                                                              Important

                                                                                              When encoding a turf (domain) in a subscription or scry path, you must use ++wood encoding as described in this function, except without the leading ~.. If your domain does not contain unusual characters, just lowercase letters, numbers and hyphens, you can just put a tilde (~) before each dot separator rather than using the full function above.

                                                                                              Returns

                                                                                              A proof.

                                                                                              Example

                                                                                              /proof/example~.com

                                                                                              /all

                                                                                              Get the complete state of all existing requests.

                                                                                              Returns

                                                                                              You'll receive an initAll update containing the current state.


                                                                                              /all/since/[stamp]

                                                                                              Get all requests later than the specified stamp, and their statuses.

                                                                                              Returns

                                                                                              You'll receive an initAll update containing the current state of requests later than the one specified.

                                                                                              Example

                                                                                              /all/since/1666875948253000000

                                                                                              /all/before/[stamp]

                                                                                              Get all requests before the specified stamp, and their statuses.

                                                                                              Returns

                                                                                              You'll receive an initAll update containing the current state of requests earlier than the one specified.

                                                                                              Example

                                                                                              /all/before/1666875948253000000

                                                                                              /turf/[turf]

                                                                                              Get the state of all existing requests for the specifed turf (domain).

                                                                                              Important

                                                                                              When encoding a turf (domain) in a subscription or scry path, you must use ++wood encoding as described in this function, except without the leading ~.. If your domain does not contain unusual characters, just lowercase letters, numbers and hyphens, you can just put a tilde (~) before each dot separator rather than using the full function above.

                                                                                              Returns

                                                                                              You'll receive an initTurf update containing all requests for the specified turf, and their statuses.

                                                                                              Example

                                                                                              /turf/example~.com

                                                                                              /turf/[turf]/since/[stamp]

                                                                                              Get the state of all existing requests for the specifed turf (domain) later than the specified stamp.

                                                                                              Important

                                                                                              When encoding a turf (domain) in a subscription or scry path, you must use ++wood encoding as described in this function, except without the leading ~.. If your domain does not contain unusual characters, just lowercase letters, numbers and hyphens, you can just put a tilde (~) before each dot separator rather than using the full function above.

                                                                                              Returns

                                                                                              You'll receive an initTurf update containing all entries with stamp s later than the one specified.

                                                                                              Example

                                                                                              /turf/example~.com/since/1666875948253000000

                                                                                              /turf/before/[stamp]

                                                                                              Get the state of all existing requests for the specifed turf (domain) earlier than the specified stamp.

                                                                                              Important

                                                                                              When encoding a turf (domain) in a subscription or scry path, you must use ++wood encoding as described in this function, except without the leading ~.. If your domain does not contain unusual characters, just lowercase letters, numbers and hyphens, you can just put a tilde (~) before each dot separator rather than using the full function above.

                                                                                              Returns

                                                                                              You'll receive an initTurf update containing all entries for the specified turf (domain) with stamps earlier than the one specified.

                                                                                              Example

                                                                                              /turf/example~.com/before/1666875948253000000

                                                                                              /ship/[ship]

                                                                                              Get the state of all existing requests for the specifed ship.

                                                                                              Returns

                                                                                              You'll receive an initShip update containing all requests for the specified ship, and their statuses.

                                                                                              Example

                                                                                              /ship/sampel-palnet

                                                                                              /ship/[ship]/since/[stamp]

                                                                                              Get the state of all existing requests for the specifed ship later than the specified stamp.

                                                                                              Returns

                                                                                              You'll receive an initShip update containing all entries for the specified ship with stamp s later than the one specified.

                                                                                              Example

                                                                                              /ship/sampel-palnet/since/1666875948253000000

                                                                                              /ship/[ship]/before/[stamp]

                                                                                              Get the state of all existing requests for the specifed ship earlier than the specified stamp.

                                                                                              Returns

                                                                                              You'll receive an initShip update containing all entries for the specified ship with stamp s before the one specified.

                                                                                              Example

                                                                                              /ship/sampel-palnet/before/1666875948253000000

                                                                                              /stamp/[stamp]

                                                                                              Get a particular request and its current status.

                                                                                              Returns

                                                                                              An entry update containing the request in question and its current status.

                                                                                              Example

                                                                                              /stamp/1666875948253000000

                                                                                              /stamp/status/[stamp]

                                                                                              Get the status of a particular request.

                                                                                              Returns

                                                                                              A status update containing the status of the request with the specified stamp.

                                                                                              Example

                                                                                              /stamp/status/1666875948253000000

                                                                                              <-

                                                                                              Subscriptions

                                                                                              Types

                                                                                              ->

                                                                                              Edit this page on GitHub

                                                                                              Last modified October 31, 2022