Get a graph neighbourhood

Everything within N hops of a document, WITH the edges that connect them and the predicate on each. Useful for asking what a passage, person or theme is connected to without fetching each document.

Filter with type to ask a shaped question — the places near an event, the people in an epoch — and with predicate to keep only one kind of edge. Depth 1 is direct links; depth 3 gets large quickly and is capped by limit. See /vocabulary for what each predicate means.

get/graph/{path}

Request

  • Base URL: https://vineverse.bible/api/v1
  • URL: https://vineverse.bible/api/v1/graph/{path}
  • Auth: none required

Path parameters

pathstring required

Query parameters

depthinteger
type'Person' | 'Place' | 'Theme' | 'Lexeme' | 'Commandment' | 'Event' | 'Epoch' | 'Book' | 'Chapter' | 'Source' | 'Dataset' | 'Relation Vocabulary'

Restrict to one collection. Plurals and folder names also resolve ("themes", "sa/events").

predicatestring

Keep only edges with this predicate.

limitinteger
offsetinteger

Skip this many nodes, in walk order. Edges are those internal to the page, so one spanning a page boundary appears on neither — fetch the neighbourhood in a single call if you need the edges whole.

Response

Nodes and edges within the requested radius.

rootstring required
depthinteger required
totalinteger

Nodes this walk reached. The walk stops at offset+limit, so while truncated is true the neighbourhood is larger than this.

offsetinteger
countinteger required
truncatedboolean

True when limit cut the walk short.

edgeCountinteger

Changes

No recorded changes to this operation across all 1 revision of this API.