API docs

The API itself is in its very early stages. Everything will change, but here are some sample URLs to play with. Keep in mind that these URLs all return JSON. Here are few things to keep in mind.

• All URLs return JSON
• For pretty JSON, pass the pretty parameter. eg pretty=true
• To limit your results, pass the size parameter. eg size=100000
• To limit the fields returned, pass a comma-separated list in the fields param. eg fields=_source.distvname,_source.name

Search for a Module

By module name:

http://api.metacpan.org/module/Moose::Meta::Attribute::Native::MethodProvider::Counter

By distribution name:

http://api.metacpan.org/module/_search?q=dist:moose

By author name:

Note that for this type of search, the author id must be in lower case.

http://api.metacpan.org/module/_search?q=author:oalders

Alternate syntax:

curl -XGET 'api.metacpan.org/module/_search?pretty=true' -d '{
    "query" : {
        "term" : { "author" : "oalders" }
    }
}
'

List all modules:

http://api.metacpan.org/module/_search?q=*&size=100000

Same list, but return only "name" and "distvname" fields: http://api.metacpan.org/module/_search?&fields=_source.distvname,_source.name&q=*&size=100000

Search for an author

By PAUSEID (exact match)

http://api.metacpan.org/author/DROLSKY

By PAUSEID (wildcard match)

http://api.metacpan.org/author/_search?q=author:D*

By name (find all Daves)

http://api.metacpan.org/author/_search?q=name:Dave

By full name

http://api.metacpan.org/author/_search?q=name:%22dave%20rolsky%22

List all authors

http://api.metacpan.org/author/_search?pretty=true&q=*&size=100000

Search for CPANRatings (http://cpanratings.perl.org/)

By distribution name (exact match)

http://api.metacpan.org/cpanratings/Moose

By distribution name (find all rated Moose distros)

http://api.metacpan.org/cpanratings/_search?q=dist:Moose

Search for Pod

By module name (exact Match)

http://api.metacpan.org/pod/AAA::Demo