Menu

JsonPath Notation

JsonPath expressions always refer to a JSON structure in the same way as XPath expressions are used in combination with an XML document.
The "root member object" in JsonPath is always referred to as $ regardless if it is an object or array.
JsonPath expressions can use the "dot"-notation like $.store.book[0].title or the "bracket"-notation like $['store']['book'][0]['title'].

Operators

Operator Description

$

The root element to query. This starts all path expressions.

@

The current node being processed by a filter predicate.

*

Wildcard. Available anywhere a name or numeric are required.

..

Deep scan. Available anywhere a name is required.

.<name>

Dot-notated child

['<name>' (, '<name>')]

Bracket-notated child or children

[<number> (, <number>)]

Array index or indexes

[start:end]

Array slice operator

[?(<expression>)]

Filter expression. Expression must evaluate to a boolean value.

Functions

Functions can be invoked at the tail end of a path - the input to a function is the output of the path expression.
The function output is dictated by the function itself.

Function Description

time()

Returns the current time in milliseconds since the epoch, like 1750419614000

iso()

Returns the current time in ISO 8601 format, like 2024-06-20T12:00:00Z

min()

Provides the min value of an array of numbers.

max()

Provides the max value of an array of numbers.

avg()

Provides the average value of an array of numbers.

stddev()

Provides the standard deviation value of an array of numbers.

length()

Provides the length of an array.

sum()

Provides the sum value of an array of numbers.

keys()

Provides the property keys (An alternative for terminal tilde ~).

concat(X)

Provides a concatenated version of the path output with a new item.

append(X)

add an item to the json path output array.

first()

Provides the first item of an array.

vlast()`

Provides the last item of an array.

vindex(X)`

Provides the item of an array of index: X, if the X is negative, take from backwards.

Filter Operators

Filters are logical expressions used to filter arrays. A typical filter would be [?(@.age > 18)] where @ represents the current item being processed. More complex filters can be created with logical operators && and ||. String literals must be enclosed by single or double quotes ([?(@.color == 'blue')] or [?(@.color == "blue")]).

Operator Description

==

Left is equal to right (note that 1 is not equal to '1').

!=

Left is not equal to right.

<

Left is less than right.

⇐

Left is less or equal to right.

>

Left is greater than right.

>=

Left is greater than or equal to right.

=~

Left matches regular expression [?(@.name =~ /foo.*?/i)].

in

Left exists in right [?(@.size in ['S', 'M'])].

nin

Left does not exists in right.

subsetof

Left is a subset of right [?(@.sizes subsetof ['S', 'M', 'L'])].

anyof

Left has an intersection with right [?(@.sizes anyof ['M', 'L'])].

noneof

Left has no intersection with right [?(@.sizes noneof ['M', 'L'])].

size

Size of left (array or string) should match right.

empty

Left (array or string) should be empty.

Path Examples

Given the JSON data:

{
    "store": {
        "book": [
            {
                "category": "reference",
                "author": "Nigel Rees",
                "title": "Sayings of the Century",
                "price": 8.95
            },
            {
                "category": "fiction",
                "author": "Evelyn Waugh",
                "title": "Sword of Honour",
                "price": 12.99
            },
            {
                "category": "fiction",
                "author": "Herman Melville",
                "title": "Moby Dick",
                "isbn": "0-553-21311-3",
                "price": 8.99
            },
            {
                "category": "fiction",
                "author": "J. R. R. Tolkien",
                "title": "The Lord of the Rings",
                "isbn": "0-395-19395-8",
                "price": 22.99
            }
        ],
        "bicycle": {
            "color": "red",
            "price": 19.95
        }
    },
    "expensive": 10
}


Expression examples to extract information out of the data above:

JsonPath Result

$.store.book[*].author

The authors of all books

$..author

All authors

$.store.*

All things, both books and bicycles

$.store..price

The price of everything

$..book[2]

The third book

$..book[-2]

The second to last book

$..book[0,1]

The first two books

$..book[:2]

All books from index 0 (inclusive) until index 2 (exclusive)

$..book[1:2]

All books from index 1 (inclusive) until index 2 (exclusive)

$..book[-2:]

Last two books

$..book[2:]

All books from index 2 (inclusive) to last

$..book[?(@.isbn)]

All books with an ISBN number

$.store.book[?(@.price < 10)]

All books in store cheaper than 10

$..book[?(@.price ⇐ $['expensive'])]

All books in store that are not "expensive"

$..book[?(@.author =~ /.*REES/i)]

All books matching regex (ignore case)

$..*

Give me every thing

$..book.length()

The number of books