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

Conflicts

None