tidwall /gjson

Get JSON values quickly - JSON parser for Go

★ 15,564⑂ 1,454👁 157⑃ 0● 335▤ 0
GoMITCreated 2016-08-11
+2
日增长
15,564
stars
1,454
forks
157
watchers
0
prs
335
issues
0
releases

README

get json values quickly

GJSON is a Go package that provides a fast and simple way to get values from a json document.
It has features such as one line retrieval, dot notation paths, iteration, and parsing json lines.

Also check out SJSON for modifying json, and the JJ command line tool.

This README is a quick overview of how to use GJSON, for more information check out GJSON Syntax.

GJSON is also available for Python and Rust

Getting Started
===============

 Installing

To start using GJSON, install Go and run go get:

sh
$ go get -u github.com/tidwall/gjson


This will retrieve the library.

 Get a value
Get searches json for the specified path. A path is in dot syntax, such as "name.last" or "age". When the value is found it's returned immediately. 

go
package main

import "github.com/tidwall/gjson"

const json = {"name":{"first":"Janet","last":"Prichard"},"age":47}

func main() {
	value := gjson.Get(json, "name.last")
	println(value.String())
}


This will print:


Prichard

There's also GetBytes for working with JSON byte slices.

 Path Syntax

Below is a quick overview of the path syntax, for more complete information please
check out GJSON Syntax.

A path is a series of keys separated by a dot.
A key may contain special wildcard characters '\' and '?'.
To access an array value use the index as the key.
To get the number of elements in an array or to access a child path, use the '' character.
The dot and wildcard characters can be escaped with '\\'.

json
{
  "name": {"first": "Tom", "last": "Anderson"},
  "age":37,
  "children": ["Sara","Alex","Jack"],
  "fav.movie": "Deer Hunter",
  "friends": [
    {"first": "Dale", "last": "Murphy", "age": 44, "nets": ["ig", "fb", "tw"]},
    {"first": "Roger", "last": "Craig", "age": 68, "nets": ["fb", "tw"]},
    {"first": "Jane", "last": "Murphy", "age": 47, "nets": ["ig", "tw"]}
  ]
}


"name.last"           "Anderson"
"age"                 37
"children"            ["Sara","Alex","Jack"]
"children."          3
"children.1"          "Alex"
"child.2"            "Jack"
"c?ildren.0"          "Sara"
"fav\.movie"          "Deer Hunter"
"friends..first"     ["Dale","Roger","Jane"]
"friends.1.last"      "Craig"


You can also query an array for the first match by using (...), or find all 
matches with (...). Queries support the ==, !=, , = 
comparison operators and the simple pattern matching % (like) and !% 
(not like) operators.


friends.(last=="Murphy").first     "Dale"
friends.(last=="Murphy").first    ["Dale","Jane"]
friends.(age45).last             ["Craig","Murphy"]
friends.(first%"D").last          "Murphy"
friends.(first!%"D").last         "Craig"
friends.(nets.(=="fb")).first    ["Dale","Roger"]


Please note that prior to v1.3.0, queries used the [...] brackets. This was
changed in v1.3.0 as to avoid confusion with the new
multipath syntax. For backwards compatibility, 
[...] will continue to work until the next major release.

 Result Type

GJSON supports the json types string, number, bo

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON