Skip to main content

Python client library for Mercado Radar API

Project description

Mercado Radar - SDK

The Mercado Radar SDK library provides convenient access to the Mercado Radar API from applications written in the Python language. It includes a pre-defined set of classes for API resources that initialize themselves dynamically from API responses.

For more information visit the API Documentation.

Installation

You don't need the source code unless you want to modify the package for contribution. If you just want to use the package, just run:

pip install mercadoradar

Usage

Authentication

The library needs to be configured with your users's API Token which you can get it through suporte@mercadoradar.com.br

  1. Set it as the MERCADORADAR_TOKEN environment variable before using the library:
export MERCADORADAR_TOKEN='YOUR_API_TOKEN'
  1. Or set directly on initialization:
from src.mercadoradar import MercadoRadar

mercadoradar = MercadoRadar(token='YOUR_API_TOKEN')

Resources

All resources have the methods:

  • create
  • retrieve
  • update
  • delete
  • list
Resource Module
Account account
Attribute Type attribute_type
Attribute Value attribute_value
Brand brand
Category category
Filter filter
Product product
Product Attribute Value product_attribute_value
Product History product_history
Search search
Seller seller
Site site
User user

Examples

from src import MercadoRadar

mercadoradar = MercadoRadar(token="YOUR_TOKEN")

products = mercadoradar.product.list()
out_of_stock_products = mercadoradar.product.list(status=["OUT_OF_STOCK"])
my_product = mercadoradar.product.retrieve(id=1)

sellers = mercadoradar.seller.list()
my_seller = mercadoradar.seller.retrieve(id=1)

brazil_sites = mercadoradar.site.list(country="BRAZIL")

my_product_history = mercadoradar.product_history.list(product_id=1)

Requirements

Python 3.10.*

Development

  1. Install dependencies
poetry env use python3.10
poetry config virtualenvs.in-project true
poetry install

Publish

poetry config pypi-token.pypi <TOKEN>
poetry build
poetry publish --build

Licence

MIT License

Copyright (c) 2025 Mercado Radar

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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

mercadoradar-2.0.3.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

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

mercadoradar-2.0.3-py3-none-any.whl (64.9 kB view details)

Uploaded Python 3

File details

Details for the file mercadoradar-2.0.3.tar.gz.

File metadata

  • Download URL: mercadoradar-2.0.3.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.12.3 Linux/6.11.0-17-generic

File hashes

Hashes for mercadoradar-2.0.3.tar.gz
Algorithm Hash digest
SHA256 94638cb4a95f5200faf5ea6f289ae161625753f2a20c4cc57adec185cfa9095e
MD5 7f393acc40ecf2425ee8e53c36b4a6a8
BLAKE2b-256 fab6a9d6b10c7db79f8b9b9dbdb4cd29d1a399a3f9d7af6c75744674de586760

See more details on using hashes here.

File details

Details for the file mercadoradar-2.0.3-py3-none-any.whl.

File metadata

  • Download URL: mercadoradar-2.0.3-py3-none-any.whl
  • Upload date:
  • Size: 64.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.12.3 Linux/6.11.0-17-generic

File hashes

Hashes for mercadoradar-2.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 958e84d1b7284bee4e5f70a6b3c88558432a435b5485a6faa752d002dc4014c8
MD5 bdb1fd79369a4756b267137efaa8055d
BLAKE2b-256 d58bc333885e542f218ba8ec85f54f5c04193675618f2f01e30360e893af6cd4

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