/ 
Finance-SE-IDX-Static-20180907.0.0
River stage one • 4 direct dependents • 8 total dependents
/ Finance::SE::IDX::Static

NAME

Finance::SE::IDX::Static - List firms listed on the IDX

VERSION

This document describes version 20180907.0.0 of Finance::SE::IDX::Static (from Perl distribution Finance-SE-IDX-Static), released on 2018-09-07.

SYNOPSIS

use Finance::SE::IDX::Static qw(list_idx_firms list_idx_sectors list_idx_boards);

my $res = list_idx_boards();

my $res = list_idx_firms();

# filter by sectors and/or board
my $res = list_idx_firms(
    board => "PENGEMBANGAN", # for development board, or "UTAMA" for main board
    sector => "AGRI",
);

my $res = list_idx_sectors();

DESCRIPTION

This module is the static (offline) version of Finance::SE::IDX. It provides the same functions and arguments, but the data is cached in the source code. It is useful as a fallback when the source that Finance::SE::IDX uses is unavailable. As a consequence, the data will be somewhat out of date.

FUNCTIONS

list_idx_boards

Usage:

list_idx_boards() -> [status, msg, result, meta]

List boards.

This function is not exported by default, but exportable.

No arguments.

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

list_idx_firms

Usage:

list_idx_firms(%args) -> [status, msg, result, meta]

List firms listed on the IDX.

REPLACE ME

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

  • board => str

    Filter by value of board.

  • sector => str

    Filter by value of sector.

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

list_idx_sectors

Usage:

list_idx_sectors() -> [status, msg, result, meta]

List sectors.

This function is not exported by default, but exportable.

No arguments.

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

HOMEPAGE

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

SOURCE

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

BUGS

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

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

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2018 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.