The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Finance-SE-IDX-0.008
River stage one • 3 direct dependents • 3 total dependents
++
/ Finance::SE::IDX

NAME

Finance::SE::IDX - Get information from Indonesian Stock Exchange

VERSION

This document describes version 0.008 of Finance::SE::IDX (from Perl distribution Finance-SE-IDX), released on 2021-06-08.

DESCRIPTION

This module currently uses Firefox::Marionette to get data from server. If you get error when retrieving data, try enabling the debug to see the URL and then access the URL in your browser to get through CAPTCHA verification.

CONTRIBUTOR

perlancar (on netbook-dell-xps13) <perlancar@gmail.com>

FUNCTIONS

get_idx_daily_trading_summary

Usage:

 get_idx_daily_trading_summary(%args) -> [$status_code, $reason, $payload, \%result_meta]

Get daily trading summary.

This will retrieve end-of-day data for a single trading day, containing list of stock names along with their opening price, closing price, highest price, lowest price, volume, frequency, foreign buy & sell volume, etc.

To specify date you can either specify date (epoch, or YYYY-MM-DD string in command-line, which will be coerced to epoch) or day, month, year.

The data for still-trading current day will not be available, so if you are looking for intraday data, this is not it.

At the time of this writing (2021-01-17), the data goes back to Jan 1st, 2015. If you are looking for older data, you can visit one of the financial data websites like Bloomberg.

This function is not exported.

Arguments ('*' denotes required arguments):

  • date => date

  • day => int

  • month => int

  • year => int

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

list_idx_boards

Usage:

 list_idx_boards() -> [$status_code, $reason, $payload, \%result_meta]

List boards.

By default caches results for 8 hours (by locally setting CACHE_MAX_AGE). Can be overriden by using HTTP_TINY_CACHE_MAX_AGE.

This function is not exported by default, but exportable.

No arguments.

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

list_idx_brokers

Usage:

 list_idx_brokers() -> [$status_code, $reason, $payload, \%result_meta]

List brokers.

By default caches results for 8 hours (by locally setting CACHE_MAX_AGE). Can be overriden by using HTTP_TINY_CACHE_MAX_AGE.

This function is not exported by default, but exportable.

No arguments.

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

list_idx_firms

Usage:

 list_idx_firms(%args) -> [$status_code, $reason, $payload, \%result_meta]

List firms.

By default caches results for 8 hours (by locally setting CACHE_MAX_AGE). Can be overriden by using HTTP_TINY_CACHE_MAX_AGE.

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

  • board => str

  • sector => str

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

list_idx_sectors

Usage:

 list_idx_sectors() -> [$status_code, $reason, $payload, \%result_meta]

List sectors.

By default caches results for 8 hours (by locally setting CACHE_MAX_AGE). Can be overriden by using HTTP_TINY_CACHE_MAX_AGE.

This function is not exported by default, but exportable.

No arguments.

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Finance-SE-IDX.

SOURCE

Source repository is at https://github.com/perlancar/perl-Finance-SE-IDX.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Finance-SE-IDX

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SEE ALSO

Finance::SE::IDX::Static for the static (offline) version

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021, 2020 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.