Astro-ADS

 view release on metacpan or  search on metacpan

CONTRIBUTING.md  view on Meta::CPAN

Read it over from the point of view of someone receiving the PR (i.e. me).

**Do** run the tests.
`dzil` helps with the build process but is not required for just raising an issue.
`perltidy` helps keep it easy to read.

## Reference documentation

The [ADS API docs](https://ui.adsabs.harvard.edu/help/api/api-docs.html)
are extensive. If you get an API dev key, you can run queries against all their
endpoints and see the responses.

ChangeLog  view on Meta::CPAN

1.92      2025 Nov 12
===
* bug in condition check on number of rows fixed by @esabol (Ed Sabol)
* added query_tree method to get AST of query
* added bigquery method to take a long list of bibcodes to filter query on
* post_response method now takes both string content and json payload

1.91      2025 Oct 16
===
* Citation Metrics Report - added all 3 endpoints
* fixed post_response method in Astro::ADS to send json payload

1.90_70   2025 Jul 18 (TRIAL RELEASE)
====
* error attribute for Result object now a hash for better reporting
* adding a test module to provide a mocked dev key

1.90      2025 Feb 22
====
* initial interface to the ADS Search endpoint

ROADMAP.md  view on Meta::CPAN

No official announcment has been made yet, so the interfaces are still
flexible and may be liable to change.

## v2.0 - public release in 2026

By this point, we should stop and look at the interfaces
and make them intuitive and consistent with the other clients.
I should have 5 more APIs ready by then, so there will be
plenty to discuss with the ADS dev team.

## Currently implemented endpoints as of v1.92

* Search
* Metrics

lib/Astro/ADS/Metrics.pm  view on Meta::CPAN

}

1;

=pod

=encoding UTF-8

=head1 NAME

Astro::ADS::Metrics - Queries the ADS Metrics endpoint and collects the results

=head1 VERSION

version 1.92

=head1 SYNOPSIS

    my $metrics = Astro::ADS::Metrics->new({
        bibcodes  => ['...'],  # list of bibcodes
        { types => ['basic'] } # types of metrics to return

lib/Astro/ADS/Metrics.pm  view on Meta::CPAN

An optional hash ref can limit the types of metrics
returned and if the type is histogram, which histograms
to return. As in

    { types    => ['histograms'], histograms => ['citations'] }

Returns the json response as a hash reference.

=head2 details

Queries the metrics/details endpoint with a list of bibcodes.
Takes no options.
Returns the json response as a hash reference.

=head2 Notes

This module's client methods are liable to change,
but deprecation warnings will be issued if they do.
See the docs.

=head1 TODO

lib/Astro/ADS/Search.pm  view on Meta::CPAN

}

1;

=pod

=encoding UTF-8

=head1 NAME

Astro::ADS::Search - Queries the ADS Search endpoint and collects the results

=head1 VERSION

version 1.92

=head1 SYNOPSIS

    my $search = Astro::ADS::Search->new({
        q  => '...', # initial search query
        fl => '...', # return list of attributes