Skip to main content

A Python library providing an asynchronous API interface for pcolle.com / gcolle.net

Project description

xcolle-api

PyPI - Version PyPI - Python Version Python Version License linting - Ruff

A Python library providing an asynchronous API interface for pcolle.com / gcolle.net.

Installation

You can install using uv:

uv tool install git+https://github.com/NTFSvolume/xcolle-api.git

Data Model

The objects returned by the API are dataclasses, with 2 convinience methods:

  • as_dict: Same as dataclasses.asdict
  • as_json: Returns a JSON string representation of the object

Quick Start

Basic example on how to use it:

import asyncio
from pathlib import Path

from xcolle_api import PcolleAPI


async def fetch_product(product_id: str) ->  None:
    async with PcolleAPI() as api:
        product = await api.product(product_id)

    print(product.as_dict())
    Path(f"product_{product_id}.json").write_text(product.as_json())


if __name__ == "__main__":
    asyncio.run(fetch_product("197240637f2aa245ecf"))

Output

{
  "id": "197240637f2aa245ecf",
  "file_name": "p902.mp4",
  "file_size": "238.11 MB",
  "file_size_bytes": 249676431,
  "ratings": 3,
  "views": 7208,
  "price": 920,
  "title": "あの同僚さんがついにパンティまでも・・・固定カメラ版",
  "sales_start_date": "2022-11-24 00:00:00+00:00",
  "seller_id": "5975951e350bdd97",
  "thumbnail": "https://img.pcolle.com/5975951e350bdd97/197240637f2aa245ecf/132828_300x225.jpg",
  "url": "https://www.pcolle.com/product/detail/?product_id=197240637f2aa245ecf",
  "category": {
    "id": 5,
    "name": "店員・OL・働く女性"
  },
  "contains": [],
  "set": "197243637f2c0257993",
  "additional_info": [
    "セット商品として購入できます"
  ],
  "description": "商品説...",
  "description_html": "<p class=\"title-item title-05\">商品説明</p>...",
  "previews": [
    "https://img.pcolle.com/5975951e350bdd97/197240637f2aa245ecf/132828_1.jpg",
    "https://img.pcolle.com/5975951e350bdd97/197240637f2aa245ecf/132828_2.jpg",
    "https://img.pcolle.com/5975951e350bdd97/197240637f2aa245ecf/132828_3.jpg",
    "https://img.pcolle.com/5975951e350bdd97/197240637f2aa245ecf/132828_4.jpg",
    "https://img.pcolle.com/5975951e350bdd97/197240637f2aa245ecf/132828_5.jpg",
    "https://img.pcolle.com/5975951e350bdd97/197240637f2aa245ecf/174045_ab6.jpg"
  ],
  "tags": [
    {
      "id": 125,
      "name": "パンチラ"
    },
    {
      "id": 18,
      "name": "胸チラ"
    },
    {
      "id": 32,
      "name": "OL"
    },
    {
      "id": 47,
      "name": "アイドル風"
    },
    {
      "id": 74,
      "name": "生足"
    },
    {
      "id": 75,
      "name": "スカートめくり"
    },
    {
      "id": 86,
      "name": "カメラ目線"
    },
    {
      "id": 99,
      "name": "美尻"
    },
    {
      "id": 109,
      "name": "開脚"
    }
  ],
  "manage_id": "5975951e350bdd97",
  "bonus": null
}

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

xcolle_api-0.1.0.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xcolle_api-0.1.0-py3-none-any.whl (18.0 kB view details)

Uploaded Python 3

File details

Details for the file xcolle_api-0.1.0.tar.gz.

File metadata

  • Download URL: xcolle_api-0.1.0.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.8

File hashes

Hashes for xcolle_api-0.1.0.tar.gz
Algorithm Hash digest
SHA256 178170e8beb2f2466224220800a7cdda604954825ef6376f2c15138fe4a6e5c7
MD5 1a767afa4e079997451d90cb6d03d3ee
BLAKE2b-256 d59f37f1257ce6447c50fbf90ee521551e03ee84fc78b09697dbc1304c2895f7

See more details on using hashes here.

File details

Details for the file xcolle_api-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: xcolle_api-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 18.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.8

File hashes

Hashes for xcolle_api-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 50344a169b91cdbf9823f567ebe1ef5d9f55bb178a27524f1bbaade2f472ce0f
MD5 8256701c896003ad72e37edb9cddb1cc
BLAKE2b-256 f3a0dad653b9fd186e792ebfa713b02fcdf345fc19e1a57265b9c4183f7b9f8e

See more details on using hashes here.

Supported by

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