package yojson

  1. Overview
  2. Docs
Yojson is an optimized parsing and printing library for the JSON format

Install 

dune-project
 Dependency

github.com Readme Changelog BSD-3-Clause License Edit opam file Versions (15)

Authors

  1. M
    Martin Jambon

Maintainers

  1. P
    paul-elliot@tarides.com
  2. N
    nathan@tarides.com
  3. M
    marek@tarides.com

Sources

yojson-3.0.0.tbz
sha256=99414da7609b92a02474ef4b49ecda15edc8cbba5229341b124e7e4695c39610
sha512=896d0ea829a36ccadba6628800369c1a3ab9e7c64dbda8b76331889c9db481cd64e137f467481ae80a8dd5fca45d748bfa71f58641806cc1bb1a007f8291789f

Description

Yojson is an optimized parsing and printing library for the JSON format.

ydump is a pretty-printing command-line program provided with the yojson package.

Published: 02 Jun 2025

README

Yojson: JSON library for OCaml

Build Status

This library parses JSON data into a nested OCaml tree data structure.

Library documentation

Currently at https://ocaml-community.github.io/yojson/

Examples

A simple example on how to parse JSON from a string literal.

let json_string = {|
  {"number" : 42,
   "string" : "yes",
   "list": ["for", "sure", 42]}|}
(* val json_string : string *)

let json = Yojson.Safe.from_string json_string
(* val json : Yojson.Safe.t *)

let () = Format.printf "Parsed to %a" Yojson.Safe.pp json

Yojson is a pretty common choice for parsing JSON in OCaml, as such it is the base for a number of tools and libraries that are built on top of it.

  • ppx_deriving_yojson to automatically generate code that converts between Yojson.Safe.t and custom OCaml types
  • ppx_yojson_conv, an alternative to ppx_deriving_yojson from Jane Street with different design decisions
  • atd, generates mapping code from .atd specification files and can be used in multiple languages
  • jsonm is an alternate JSON parser that parses JSON into a stream of items, so the complete data structure does not have to be in memory.

Help wanted

Yojson is developed and maintained by volunteers — users like you. Various issues are in need of attention. If you'd like to contribute, please leave a comment on the issue you're interested in, or create a new issue. Experienced contributors will guide you as needed.

There are many simple ways of making a positive impact. For example, you can...

  • Use the software in your project.
  • Give a demo to your colleagues.
  • Share the passion on your blog.
  • Tweet about what you're doing with Yojson.
  • Report difficulties by creating new issues. We'll triage them.
  • Ask questions on StackOverflow.
  • Answer questions on StackOverflow.
  • Discuss usage on the OCaml forums.
  • Pick a task that's easy for you.

Check out in particular good first time issues and other issues with which we could use some help.

License

Yojson is licensed under the 3-clause BSD license, see LICENSE.md for details.

Dependencies (2)

  1. ocaml >= "4.08"
  2. dune >= "2.7"

Dev Dependencies (2)

  1. odoc with-doc
  2. alcotest with-test & >= "0.8.5"

  1. 0install >= "2.18"
  2. abella >= "2.0.8"
  3. acgtk
  4. anthropic
  5. archetype
  6. atd >= "2.6.0"
  7. atdgen >= "3.0.1"
  8. atdgen-runtime >= "2.10.0"
  9. atdml
  10. avro-compiler
  11. avro-simple
  12. aws-config
  13. aws-s3 < "4.5.1" | >= "4.8.0"
  14. awsm-codegen
  15. bap-radare2
  16. bitcoin >= "3.0"
  17. boulangerie
  18. builder-web >= "0.2.0"
  19. caisar
  20. calculon != "0.5"
  21. calculon-redis-lib
  22. calculon-web = "0.6"
  23. camelot >= "1.3.0"
  24. camels
  25. canary
  26. catala = "0.9.0" | >= "1.0.0~beta"
  27. cb-check
  28. cbor >= "0.3"
  29. cconv-ppx
  30. chess_com_api
  31. colibrics
  32. comby-semantic
  33. commons
  34. containers >= "3.9"
  35. coq-lsp
  36. coq-of-ocaml
  37. coq-serapi >= "8.10.0+0.7.0" & < "8.20.0+0.20.0"
  38. crs >= "0.0.20250705"
  39. current_docker
  40. current_examples
  41. current_git
  42. current_github
  43. current_gitlab
  44. current_slack
  45. current_ssh
  46. current_web
  47. dap
  48. daypack-lib
  49. dblp-api
  50. decoders-yojson >= "0.7.0"
  51. devkit
  52. dnsrobot
  53. docker-api >= "0.2.2"
  54. docker_hub
  55. dot-merlin-reader < "4.9"
  56. dream
  57. dream-inertia
  58. dune-cargo-build
  59. dune-release >= "1.4.0"
  60. dune_deps_extra
  61. eio_main >= "0.10"
  62. elasticsearch-cli = "0.5"
  63. elpi >= "3.3.1"
  64. fehu < "1.0.0~alpha3"
  65. fiat-p256
  66. fit >= "1.2.0"
  67. forester >= "3.1.0"
  68. frama-c < "23.0" | >= "27.0~beta"
  69. fred
  70. frenetic
  71. fstar
  72. gapi-ocaml
  73. gdbprofiler
  74. gemini
  75. gendarme-json < "0.4.0"
  76. gendarme-yojson
  77. github != "4.0.0"
  78. github-data
  79. github-unix >= "4.5.1"
  80. gitlab
  81. goblint-cil >= "1.8.0"
  82. gopcaml-mode-merlin < "0.0.6"
  83. gradescope_submit
  84. graphql < "0.9.0" | >= "0.14.0"
  85. graphql-async >= "0.14.0"
  86. graphql-cohttp >= "0.13.0"
  87. graphql-lwt >= "0.14.0"
  88. graphql_ppx
  89. gremlin
  90. guardian
  91. h2
  92. hacl_x25519
  93. handlebars-ml
  94. hilite < "0.3.0"
  95. hl_yaml
  96. hockmd
  97. horned_worm
  98. hpack
  99. hsluv
  100. httph
  101. huml
  102. huml-cli
  103. index-bench
  104. ip2location
  105. ip2locationio
  106. ip2whois
  107. irmin-graphql
  108. irmin-tezos
  109. jasmin
  110. jhupllib
  111. jose
  112. js_of_ocaml-compiler
  113. jsonrpc >= "1.23.1"
  114. jsonschema
  115. jsonschema2atd
  116. jupyter
  117. jupyter-kernel
  118. jwto
  119. kappa-library < "4.1.3"
  120. karamel
  121. kaun >= "1.0.0~alpha1" & < "1.0.0~alpha3"
  122. kremlin < "transition"
  123. kubecaml
  124. lablgtk3-extras >= "3.0.1"
  125. lambdapi
  126. learn-ocaml
  127. letsencrypt < "2.0.0"
  128. letters
  129. libsail
  130. lichess_api
  131. linol >= "0.2" & < "0.10"
  132. linol-eio
  133. linol-lwt
  134. lockfree >= "0.3.1"
  135. logs-async-reporter >= "1.3"
  136. lsp < "1.6.0" | >= "1.23.1"
  137. melange-json = "1.2.0"
  138. melange-json-native
  139. merlin != "4.5-411"
  140. metadb
  141. mirage-crypto-ec
  142. mjson
  143. monorobot
  144. mopsa
  145. multicore-bench
  146. mutaml
  147. neo4j_bolt
  148. nloge
  149. nsq
  150. obuilder
  151. ocaml-ai-sdk
  152. ocaml-lsp-server < "1.10.5" | >= "1.18.0" & != "1.21.0-4.14" & != "1.23.0"
  153. ocaml-protoc-plugin >= "6.1.0"
  154. ocaml_db_model
  155. ocaml_pgsql_model
  156. ocamleditor >= "1.15.2-ocaml414"
  157. ocf >= "1.0.0"
  158. ocsigen-start
  159. odoc >= "3.0.0"
  160. odoc-driver
  161. oframl
  162. oidc
  163. ojs-base
  164. ojs_base
  165. ometrics < "0.2.0"
  166. opam-check-npm-deps >= "4.1.0"
  167. openai-gym
  168. openapi
  169. openapi_router
  170. opencage
  171. openstellina
  172. opium >= "0.19.0"
  173. oraft
  174. orun
  175. osh
  176. oui
  177. ozulip
  178. pa_ppx < "0.14" | >= "0.19"
  179. pandoc
  180. pbrt_yojson
  181. pds-reachability >= "0.2.3"
  182. petr4
  183. pgn_parser
  184. phylogenetics >= "0.2.0"
  185. piece_rope
  186. pkcs11-driver >= "1.0.0"
  187. polymarket
  188. ppx_deriving_jsonschema
  189. ppx_deriving_yojson < "3.6.1"
  190. ppx_protocol_conv_json < "5.0.0" | >= "5.2.1"
  191. ppx_yojson
  192. ppx_yojson_conv < "v0.13.0"
  193. ppx_yojson_conv_lib
  194. ppxlib-tools >= "0.37.0"
  195. prof_spacetime
  196. pxshot
  197. qdrant
  198. qmp >= "0.19.0"
  199. query-json
  200. quests
  201. r2pipe
  202. radare2
  203. rdf
  204. records = "0.6.0" | >= "1.0.0"
  205. repr-bench
  206. rfsm >= "2.2"
  207. rocq-devtools
  208. rpclib
  209. rungen
  210. rust-staticlib-gen
  211. SZXX
  212. safemoney
  213. saga
  214. sail < "0.15"
  215. saturn
  216. saturn_lockfree
  217. satyrographos != "0.0.2.7" & < "0.0.2.13"
  218. savvy
  219. semver2
  220. serde_json
  221. server-reason-react >= "0.4.0"
  222. shakuhachi
  223. sihl < "0.2.0" | >= "0.3.0~rc2"
  224. sihl-core
  225. simple_httpd
  226. slack
  227. slug
  228. smaws-lib
  229. smtml >= "0.7.0"
  230. snf_mcp < "0.2.1"
  231. spectrum_palette_ppx
  232. spotify-web-api
  233. starred_ml
  234. swagger
  235. talon < "1.0.0~alpha3"
  236. tdigest < "2.1.0"
  237. testcontainers
  238. textmate-language >= "0.3.4"
  239. textrazor >= "0.1.1"
  240. tidy_email_sendgrid
  241. timedesc < "0.8.0"
  242. timedesc-json
  243. timere < "0.4.0"
  244. user-agent-parser
  245. vecosek
  246. vercel
  247. volgo-vcs >= "0.0.22"
  248. vscoq-language-server < "2.3.3"
  249. vsrocq-language-server
  250. wasm_of_ocaml-compiler
  251. webauthn
  252. why3find
  253. xapi-rrd >= "1.9.0"
  254. yojson-five >= "3.0.0"
  255. yosqlite >= "0.2"
  256. yultracer
  257. zanuda
  258. zarr

Conflicts

None