The VKHS package

[Tags:bsd3, library, program]

Provides access to Vkontakte API methods. Library requires no interaction with the user during Implicit-flow authentication.

[Skip to Readme]


Versions 0.0.1, 0.0.2, 0.0.3, 0.1.0, 0.1.1, 0.1.2, 0.1.3, 0.1.4, 0.1.5, 0.1.6, 0.2.0, 0.3.0, 0.3.1, 0.3.2, 0.3.3, 0.5.0, 0.5.1, 0.5.2, 0.5.3, 0.5.4, 0.5.5, 0.5.6, 0.5.7, 1.6.0, 1.6.1, 1.6.2, 1.6.3, 1.6.4, 1.7.0, 1.7.1, 1.7.2
Change log
Dependencies aeson, aeson-pretty, base (>=4.6 && <5), bytestring, case-insensitive, clock, containers, data-default-class, directory, filepath, http-client, http-client-tls, http-types, mtl, network-uri, optparse-applicative, parsec, pipes, pipes-http, pretty-show, regexpr, split, taglib, tagsoup, text, time, utf8-string, vector [details]
License BSD3
Copyright Copyright (c) 2012, Sergey Mironov
Author Sergey Mironov
Stability Unknown
Category Web
Home page
Uploaded Mon Aug 22 20:18:17 UTC 2016 by SergeyMironov
Distributions NixOS:1.7.2
Downloads 4557 total (124 in the last 30 days)
0 []
Status Docs not available [build log]
All reported builds failed as of 2016-10-26 [all 4 reports]


  • Web
    • Web.VKHS
      • Web.VKHS.API
        • Web.VKHS.API.Base
        • Web.VKHS.API.Simple
        • Web.VKHS.API.Types
      • Web.VKHS.Client
      • Web.VKHS.Error
      • Web.VKHS.Imports
      • Web.VKHS.Login
      • Web.VKHS.Monad
      • Web.VKHS.Types


Maintainer's Corner

For package maintainers and hackage trustees

Readme for VKHS

Readme for VKHS-1.7.2


VKHS provides access to Vkontakte social network, popular mainly in Russia. Library can be used to login into the network as a standalone application (OAuth implicit flow as they call it). Having the access token, it is possible to call various API methods to query audio files or retrieve wall messages. For now, vkhs offers limited error detection and no captcha support.


In order to install VKHS, type:

$ cabal update
$ cabal install VKHS

Note, that VKHS uses curlhs and should be linked with Normally, cabal handles it without problems.


VKQ is a command line tool which demonstrates API usage. It can be used for logging in, downloading music and reading wall messages.

Log in

Here is an example session: Login first

]$ vkq login pass123

VKQ returns three values. First is a access token which is required to execute future API requests. VKQ reads it from VKQ_ACCESS_TOKEN environment variable so we have to set it up

$ export VKQ_ACCESS_TOKEN=d785932b871f096bd73aac6a35d7a7c469dd788d796463a871e5beb5c61bc6c96788ec2

Download audio

Now, lets list first 10 audio files I have:

$ vkq music -l | head -n 10
910727_456939044 Алёнушка 1989 муз Никиты Богословского - ст Александра Коваленкова
910727_456939043 Первое апреля
910727_456939042 Травы травы травы не успели от росы серебрянной согнуться и такие нежные напевы почему-то прямо в сердце льются
910727_456939041 Moving On
910727_456939038  Не для меня придёт весна
910727_456939037 Каждый выбирает для себя
910727_456939034 Black Fortress Kings Bounty Dark Side OST
910727_456939031 Вокализ минус пример
910727_456939040  Без названия
910727_456939028 The Extasy of Gold

Ok, the link can be used to download the file using wget, but vkq offers some renaming options, so lets use the latter instead:

$ vkq music -o . 910727_456939043 910727_456939031
Polite Dance Song
./The Bird And The Bee - Polite Dance Song.mp3
L'estasi Dell'oro (The Ecstasy Of Gold)
./Ennio Morricone - Lestasi Delloro The Ecstasy Of Gold.mp3

Polite dance song and Ecstasy of gold mp3s will appear in the current folder.

Custom API calls

vkq allows user to call arbitrary API method. The format is as follows:

Usage: vkq call [--verbose] [--req-per-sec N] [--interactive] [--appid APPID]
                [--user USER] [--pass PASS] [-a ACCESS_TOKEN] METHOD PARAMS

For example, lets call method to get some Beatles records:

$ vkq call q=Beatles --pretty

  { "response": [
        "lyrics_id": "6604412",
        "url": "",
        "aid": 85031440,
        "title": "Twist and Shout  ",
        "genre": 1,
        "owner_id": 9559206,
        "duration": 156,
        "artist": "The Beatles"

VKHS library/Runhaskell mode

Starting from 1.7.2 there are initial support for RunHaskell-mode. Consider the following example:

#!/usr/bin/env runhaskell
{-# LANGUAGE RecordWildCards #-}

import Prelude ()
import Web.VKHS
import Web.VKHS.Imports

main :: IO ()
main = runVK_ defaultOptions $ do
  Sized cnt cs <- getCountries
  forM_ cs $ \Country{..} -> do
    liftIO $ putStrLn co_title

When executed, the program should ask for login and password and output list of countries known to VK. Consider reviewing Web.VKHS.API.Simple where getCountries and several other methods are defined. Also, check the source code of the vkq application for more elaborated usage example.


RepatedForm message means that VKHS tries to fill the web form with available data, but the form appears again. Typically, that means that the password wa invalid or captcha is required.



BSD3 license

Copyright (c) 2014, Sergey Mironov