JSONPath
Quick Start
JSON Response Example
Suppose we have the following JSON response:
{
"store": {
"book": [
{ "category": "fiction", "author": "Author A", "title": "Book 1" },
{ "category": "reference", "author": "Author B", "title": "Book 2" },
{ "category": "fiction", "author": "Author C", "title": "Book 3" }
]
}
}
Extracting Data
To extract the This expression returns "Book 1".
title of the first book in the array, use this JSONPath expression: $.store.book[0].titleJSONPath Expression Explained
Letβs break down the expressionIn summary, the expression navigates from the root, finds the
$.store.book[0].title:$: Refers to the root node of the JSON document β essentially the entire structure.store: Points to thestoreproperty, which is an object under the root node.book: Accesses thebookproperty under thestoreobject, which is an array.[0]: Selects the first element in the book array (indices start at 0).title: Retrieves thetitleof the first book in the array.storeobject, accesses thebookarray, selects the first item, and extracts thetitleof that item.0.$.store.book[?(@.category=='reference')].Syntax Overview
Basic Syntax
| Syntax | Description |
|---|---|
$ | Root node |
@ | Current node |
.node or ['node'] | Access child nodes |
[index] | Array indexing, supports counting from 0 |
[start:end:step] | Array slicing |
* | Wildcard, matches all child nodes |
.. | Recursive wildcard, matches all descendants |
(<expr>) | Dynamic expression |
?(<boolean expr>) | Filter condition |
Extended Syntax
| Syntax | Description |
|---|---|
^ | Access the parent of the matching item |
~ | Get attribute names of the matching item (as an array) |
@null(), @boolean(), @number(), @string(), @array(), @object() | Retrieve basic JSON types |
@integer() | Retrieve integer type |
@scalar() | Retrieve complex types, accepting undefined and non-finite numbers (when querying JavaScript objects) |
@other() | Can be used with a user-defined otherTypeCallback |
@undefined(), @function(), @nonFinite() | Non-JSON types used when querying non-JSON JavaScript objects |
@path, @parent, @property, @parentProperty, @root | Shorthand selectors in filters |
` | Escape remaining sequences |
@['...'], ?@['...'] | Escape special characters in attribute names within filters |
$.. | Retrieve all parent components |
JSONPath Examples
Example 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
}
}
}Example JSONPath Queries
| XPath | JSONPath | Result |
|---|---|---|
/store/book/author | $.store.book[*].author | Authors of all books |
//author | $..author | All authors |
/store/* | $.store.* | All child nodes under store |
/store//price | $.store..price | All price fields |
//book[3] | $..book[2] | Third book (0-based index) |
//book[last()] | $..book[(@.length-1)] or $..book[-1:] | Last book |
//book[position()<3] | $..book[:2] or $..book[0,1] | First two books |
//book[isbn] | $..book[?(@.isbn)] | Books with an ISBN |
//book[price<10] | $..book[?(@.price<10)] | Books priced under 10 |
//* | $..* | Recursively match all child nodes |
References
Modified atΒ 2025-02-19 09:48:29