API Integration

Last updated: 7 months ago

Fetch Visible Offers

Buy Offers

GET: /api/offers/buy Get all available and visible buy offers. Returns 100 object data at a time, with pagination included. Type: JSON

{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "token": "hTqhdYXML7",
      "type": "buy",
      "coin": "btc",
      "currency": "USD",
      "user_id": 3,
      "status": 1,
      "min_amount": 1,
      "max_amount": 2000,
      "profit_margin": 5,
      "payment_method": "eBay Gift Card",
      "tags": [
        "no verification needed",
        "no receipt needed",
        "e-codes only"
      ],
      "trade_instruction": "Instructions",
      "terms": "Terms",
      "label": "Instant Release",
      "phone_verification": 0,
      "email_verification": 0,
      "trusted_offer": 0,
      "deadline": 30,
      "created_at": "2018-11-23 11:45:24",
      "updated_at": "2018-11-23 11:45:24",
      "user": {
        "id": 3,
        "name": "user",
        "presence": "offline",
        "last_seen": "2018-11-23 16:26:53",
        "currency": "USD",
        "status": "active",
        "timezone": "Africa/Lagos",
        "verified_phone": 0,
        "verified": false,
        "schedule_delete": 0,
        "schedule_deactivate": 0,
        "profile": null
      }
    }
  ],
  "first_page_url": "http://cryptex.test/api/offers/buy?page=1",
  "from": 1,
  "last_page": 2,
  "last_page_url": "http://cryptex.test/api/offers/buy?page=2",
  "next_page_url": "http://cryptex.test/api/offers/buy?page=2",
  "path": "http://cryptex.test/api/offers/buy",
  "per_page": 1,
  "prev_page_url": null,
  "to": 1,
  "total": 2
}
                            

Sell Offers

GET: /api/offers/sell Get all available and visible sell offers. Returns 100 object data at a time, with pagination included. Type: JSON

{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "token": "hTqhdYXML7",
      "type": "sell",
      "coin": "btc",
      "currency": "USD",
      "user_id": 3,
      "status": 1,
      "min_amount": 1,
      "max_amount": 2000,
      "profit_margin": 5,
      "payment_method": "eBay Gift Card",
      "tags": [
        "no verification needed",
        "no receipt needed",
        "e-codes only"
      ],
      "trade_instruction": "Instructions",
      "terms": "Terms",
      "label": "Instant Release",
      "phone_verification": 0,
      "email_verification": 0,
      "trusted_offer": 0,
      "deadline": 30,
      "created_at": "2018-11-23 11:45:24",
      "updated_at": "2018-11-23 11:45:24",
      "user": {
        "id": 3,
        "name": "user",
        "presence": "offline",
        "last_seen": "2018-11-23 16:26:53",
        "currency": "USD",
        "status": "active",
        "timezone": "Africa/Lagos",
        "verified_phone": 0,
        "verified": false,
        "schedule_delete": 0,
        "schedule_deactivate": 0,
        "profile": null
      }
    }
  ],
  "first_page_url": "http://cryptex.test/api/offers/buy?page=1",
  "from": 1,
  "last_page": 2,
  "last_page_url": "http://cryptex.test/api/offers/buy?page=2",
  "next_page_url": "http://cryptex.test/api/offers/buy?page=2",
  "path": "http://cryptex.test/api/offers/buy",
  "per_page": 1,
  "prev_page_url": null,
  "to": 1,
  "total": 2
}