Skip to main content

Unofficial API wrapper for https://ask.fm

Project description

askfm-api

PyPI version PyPI status Code style: black Project manager: pdm

This aims to be a powerful Python wrapper around the undocumented ASKfm API for its mobile apps.

Currently based on reverse-engineering ASKfm Android app v4.67.1, which uses ASKfm API version 1.18. The core logic is quite complete, but only a small subset of API methods have helpers in the askfm_api.requests module so far.

Usage

The code should be self-explanatory so I won't go into great detail here. Quick example:

from askfm_api import AskfmApi, AskfmApiError
from askfm_api import requests as r

try:
    api = AskfmApi("<secret key>", device_id="D2A6C471C4B4DA5C")
    me = api.login("username", "password")
    print(me)
    # {'uid': 'jgrdlgrd', 'fullName': 'Снег не растает', 'location': 'my empire of dirt', ...}

    qs = api.request_iter(r.fetch_questions())
    print(next(qs))
    # {'type': 'daily', 'body': 'Hi?', 'answer': None, 'author': None, 'qid': 153352, ...}

    res = api.request(
        r.post_answer(question_type="daily", question_id=153352, text="Hi there!")
    )
    print(res)
    # {'question': {...}, 'answer': {...}}
except AskfmApiError as e:
    print(e)
    # error code returned by the API, e. g. 'session_expired'

Signing key

All requests are signed using a secret key (unique per app version) that is stored inside the official app in an obfuscated manner. I don't find it ethical to publish it, so if you want to use this library, your options are:

  • extract the key by yourself
  • contact me, explain your use case and ask for the key

Todo

  • feat: Add more methods
  • feat: Refresh expired tokens
  • tests: Add tests

Related work / See also

Contributing

Any activity is welcome, but I would be especially grateful if someone wrote tests for this code.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

askfm-api-0.1.3.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

askfm_api-0.1.3-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file askfm-api-0.1.3.tar.gz.

File metadata

  • Download URL: askfm-api-0.1.3.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.1.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.1

File hashes

Hashes for askfm-api-0.1.3.tar.gz
Algorithm Hash digest
SHA256 9e23a858fc0285157baece0b782f7ed9820adb569986eabea56c22859d7cd92b
MD5 0b3036d9c98a2572c98795a582511486
BLAKE2b-256 aa63a6f9c7e423288561023227f929628551d772cf96a3d7c4aa495bc32581f8

See more details on using hashes here.

File details

Details for the file askfm_api-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: askfm_api-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.1.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.1

File hashes

Hashes for askfm_api-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 45d7b9d39de62766f8977f3ea6125bfd40ca0803a6db4de459728e096e2dca4d
MD5 b5774fdf0ed4f45c59090f9a5879aa77
BLAKE2b-256 bae036867f8997af0820513980cb455252d5a2df3260b5faac854882172adb41

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page