NAME

idxdb - Import data for stocks on the IDX (Indonesian Stock Exchange) and perform queries on them

VERSION

This document describes version 0.008 of idxdb (from Perl distribution App-idxdb), released on 2021-06-21.

SYNOPSIS

To update data:

 % idxdb update

To see the legends for ownership field names (e.g. ForeignIB = foreign bank):

 % idxdb ownership --legend

To see ownership (e.g. % foreign/local) of some stock through time:

 % idxdb ownership BBRI
 % idxdb ownership --fields-all BBRI --date-start 2020-01-01 --date-end 2020-09-30
 % idxdb ownership --fields-foreign-total --6month --graph BBNI

To graph ownership composition (% foreign bank, foreign total, local bank, etc) of some stock:

 % idxdb ownership BBRI --graph

To see a table of daily trading summary of some stock:

 % idxdb daily BBRI

To graph closing price and accumulated foreign net buy of some stock in the last 2 year:

 % idxdb daily --field Close --field AccumForeignNetBuy --2year BBRI

DESCRIPTION

NOTE: EARLY RELEASE, ONLY A FEW SUBCOMMANDS HAVE BEEN IMPLEMENTED.

This utility lets you load some data like IDX's daily trading summary (stock summary), list of stocks, and KSEI's monthly ownership into a SQLite database and perform some SQL queries against it.

Keywords: stock trading, Indonesian Stock Exchange, securities analysis.

SUBCOMMANDS

daily

Show data from daily stock/trading summary.

ownership

Show ownership of some stock through time.

stocks-by-foreign-ownership

Rank stocks from highest foreign ownership.

update

Update data.

Currently this routine imports from text files in the gudangdata repository on the local filesystem. Functionality to import from server directly using Finance::SE::IDX and Finance::ID::KSEI will be added in the future.

OPTIONS

* marks required options.

Common options

--config-path=s, -c

Set path to configuration file.

--config-profile=s, -P

Set configuration profile to use.

--debug

Shortcut for --log-level=debug.

--format=s

Choose output format, e.g. json, text.

Default value:

 undef
--help, -h, -?

Display help message and exit.

--json

Set output format to json.

--log-level=s

Set log level.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

 0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

    [200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

    [1,2,3]
--no-config, -C

Do not use any configuration file.

--no-env

Do not read environment for default options.

--page-result

Filter output through a pager.

--quiet

Shortcut for --log-level=error.

--subcommands

List available subcommands.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

--version, -v

Display program's version and exit.

--view-result

View output using a viewer.

Options for subcommand daily

--10year

Alias for --date-start.

See --date-start.

--1month

Alias for --date-start.

See --date-start.

--1week

Alias for --date-start.

See --date-start.

--1year

Alias for --date-start.

See --date-start.

--2month

Alias for --date-start.

See --date-start.

--2year

Alias for --date-start.

See --date-start.

--3month

Alias for --date-start.

See --date-start.

--3year

Alias for --date-start.

See --date-start.

--5year

Alias for --date-start.

See --date-start.

--6month

Alias for --date-start.

See --date-start.

--date-end=s

Default value:

 1624208400
--date-start=s

Default value:

 1621616400
--field=s@

Default value:

 ["Volume","Value","ForeignNetBuy"]

Can be specified multiple times.

--fields-all

Display all fields.

See --field.

--fields-json=s

See --field.

--fields-price-all

Display all prices.

See --field.

--fields-price-and-afnb

Short for --field Close --field AccumForeignNetBuy.

See --field.

--fields-price-close

Short for --field Close.

See --field.

--graph, -g

Show graph instead of table.

--month

Alias for --date-start.

See --date-start.

--stock=s@*

Can also be specified as the 1st command-line argument and onwards.

Can be specified multiple times.

--stocks-json=s

See --stock.

Can also be specified as the 1st command-line argument and onwards.

--total
--week

Alias for --date-start.

See --date-start.

--year

Alias for --date-start.

See --date-start.

--ytd

Alias for --date-start.

See --date-start.

Options for subcommand ownership

--10year

Alias for --date-start.

See --date-start.

--1month

Alias for --date-start.

See --date-start.

--1week

Alias for --date-start.

See --date-start.

--1year

Alias for --date-start.

See --date-start.

--2month

Alias for --date-start.

See --date-start.

--2year

Alias for --date-start.

See --date-start.

--3month

Alias for --date-start.

See --date-start.

--3year

Alias for --date-start.

See --date-start.

--5year

Alias for --date-start.

See --date-start.

--6month

Alias for --date-start.

See --date-start.

--date-end=s

Default value:

 1624208400
--date-start=s

Default value:

 1621616400
--field=s@

Default value:

 ["LocalTotal","ForeignTotal"]

Can be specified multiple times.

--fields-all

Alias for --field.

See --field.

--fields-foreign

Alias for --field.

See --field.

--fields-foreign-total

Alias for --field.

See --field.

--fields-json=s

See --field.

--fields-local

Alias for --field.

See --field.

--graph, -g

Show graph instead of table.

--legend

Show legend of ownership instead (e.g. ForeignIB = foreign bank, etc).

--month

Alias for --date-start.

See --date-start.

--stock=s*

Can also be specified as the 1st command-line argument.

--week

Alias for --date-start.

See --date-start.

--year

Alias for --date-start.

See --date-start.

--ytd

Alias for --date-start.

See --date-start.

Options for subcommand update

--gudangdata-path=s*

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

 complete -C idxdb idxdb

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

 complete idxdb 'p/*/`idxdb`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/idxdb.conf, ~/idxdb.conf, or /etc/idxdb.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

To put configuration for a certain subcommand only, use a section name like [subcommand=NAME] or [SOMESECTION subcommand=NAME].

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME] or [subcommand=SUBCOMMAND_NAME profile=SOMENAME] or [SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

You can also filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable equals some string: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal some string: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when the value of an environment variable includes some string: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. If you only want a section to be read when the value of an environment variable does not include some string: [env=HOSTNAME!*=server ...] or [SOMESECTION env=HOSTNAME!*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:

 [plugin=DumpArgs]
 -event=before_validate_args
 -prio=99
 
 [plugin=Foo]
 -event=after_validate_args
 arg1=val1
 arg2=val2

 

which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.

List of available configuration parameters:

Common for all subcommands

 format (see --format)
 log_level (see --log-level)
 naked_res (see --naked-res)

Configuration for subcommand daily

 date_end (see --date-end)
 date_start (see --date-start)
 fields (see --field)
 graph (see --graph)
 stocks (see --stock)
 total (see --total)

Configuration for subcommand ownership

 date_end (see --date-end)
 date_start (see --date-start)
 fields (see --field)
 graph (see --graph)
 legend (see --legend)
 stock (see --stock)

Configuration for subcommand stocks-by-foreign-ownership

Configuration for subcommand update

 gudangdata_path (see --gudangdata-path)

ENVIRONMENT

IDXDB_OPT => str

Specify additional command-line options.

FILES

~/.config/idxdb.conf

~/idxdb.conf

/etc/idxdb.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-idxdb.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-idxdb.

BUGS

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

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

Finance::ID::KSEI

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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