yogarine/bungie-d1-sdk-php

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

These are legacy endpoints for Destiny 1 that are no longer supported officially by Bungie.

dev-master 2018-12-26 11:47 UTC

This package is auto-updated.

Last update: 2021-11-26 18:57:35 UTC


README

These are legacy endpoints for Destiny 1 that are no longer supported officially by Bungie.

This PHP package is automatically generated by the OpenAPI Generator project:

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/yogarine/bungie-d1-sdk-php.git"
    }
  ],
  "require": {
    "yogarine/bungie-d1-sdk-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/bungie-d1-sdk-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
$config = Bungie\D1\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Bungie\D1\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
// Configure OAuth2 access token for authorization: oauth2
$config = Bungie\D1\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Bungie\D1\Api\DestinyApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$inlineObject1 = new InlineObject1(); // \Bungie\D1\Model\inline_object_1 | 

try {
    $result = $apiInstance->equipItem($inlineObject1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DestinyApi->equipItem: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://bungie.net/d1/Platform

Class Method HTTP request Description
DestinyApi equipItem POST /Destiny/EquipItem/
DestinyApi equipItems POST /Destiny/EquipItems/
DestinyApi getAccount GET /Destiny/{membershipType}/Account/{destinyMembershipId}/
DestinyApi getAccountSummary GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Summary/
DestinyApi getActivityBlob GET /Destiny/Stats/ActivityBlob/{param1}/
DestinyApi getActivityHistory GET /Destiny/Stats/ActivityHistory/{membershipType}/{destinyMembershipId}/{characterId}/
DestinyApi getAdvisorsForAccount GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Advisors/
DestinyApi getAdvisorsForCharacter GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Advisors/
DestinyApi getAdvisorsForCharacterV2 GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Advisors/V2/
DestinyApi getAdvisorsForCurrentCharacter GET /Destiny/{membershipType}/MyAccount/Character/{characterId}/Advisors/
DestinyApi getAllItemsSummary GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Items/
DestinyApi getAllVendorsForCurrentCharacter GET /Destiny/{membershipType}/MyAccount/Character/{characterId}/Vendors/
DestinyApi getBondAdvisors GET /Destiny/{membershipType}/MyAccount/Advisors/Bonds/
DestinyApi getCharacter GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Complete/
DestinyApi getCharacterActivities GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Activities/
DestinyApi getCharacterInventory GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Inventory/
DestinyApi getCharacterInventorySummary GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Inventory/Summary/
DestinyApi getCharacterProgression GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Progression/
DestinyApi getCharacterSummary GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/
DestinyApi getClanLeaderboards GET /Destiny/Stats/ClanLeaderboards/{clanId}/
DestinyApi getDestinyAggregateActivityStats GET /Destiny/Stats/AggregateActivityStats/{membershipType}/{destinyMembershipId}/{characterId}/
DestinyApi getDestinyExplorerItems GET /Destiny/Explorer/Items/
DestinyApi getDestinyExplorerTalentNodeSteps GET /Destiny/Explorer/TalentNodeSteps/
DestinyApi getDestinyLiveTileContentItems GET /Destiny/LiveTiles/
DestinyApi getDestinyManifest GET /Destiny/Manifest/
DestinyApi getDestinySingleDefinition GET /Destiny/Manifest/{definitionType}/{definitionId}/
DestinyApi getExcellenceBadges GET /Destiny/Stats/GetExcellenceBadges/{membershipType}/{destinyMembershipId}/
DestinyApi getGrimoireByMembership GET /Destiny/Vanguard/Grimoire/{membershipType}/{destinyMembershipId}/
DestinyApi getGrimoireDefinition GET /Destiny/Vanguard/Grimoire/Definition/
DestinyApi getHistoricalStats GET /Destiny/Stats/{membershipType}/{destinyMembershipId}/{characterId}/
DestinyApi getHistoricalStatsDefinition GET /Destiny/Stats/Definition/
DestinyApi getHistoricalStatsForAccount GET /Destiny/Stats/Account/{membershipType}/{destinyMembershipId}/
DestinyApi getItemDetail GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Inventory/{itemInstanceId}/
DestinyApi getItemReferenceDetail GET /Destiny/{param1}/Account/{param2}/Character/{param3}/ItemReference/{param4}/
DestinyApi getLeaderboards GET /Destiny/Stats/Leaderboards/{membershipType}/{destinyMembershipId}/
DestinyApi getLeaderboardsForCharacter GET /Destiny/Stats/Leaderboards/{param1}/{param2}/{param3}/
DestinyApi getLeaderboardsForPsn GET /Destiny/Stats/LeaderboardsForPsn/
DestinyApi getMembershipIdByDisplayName GET /Destiny/{membershipType}/Stats/GetMembershipIdByDisplayName/{displayName}/
DestinyApi getMyGrimoire GET /Destiny/Vanguard/Grimoire/{membershipType}/
DestinyApi getPostGameCarnageReport GET /Destiny/Stats/PostGameCarnageReport/{activityInstanceId}/
DestinyApi getPublicAdvisors GET /Destiny/Advisors/
DestinyApi getPublicAdvisorsV2 GET /Destiny/Advisors/V2/
DestinyApi getPublicVendor GET /Destiny/Vendors/{vendorHash}/
DestinyApi getPublicVendorWithMetadata GET /Destiny/Vendors/{vendorHash}/Metadata/
DestinyApi getPublicXurVendor GET /Destiny/Advisors/Xur/
DestinyApi getRecordBookCompletionStatus GET /Destiny/{membershipType}/MyAccount/RecordBooks/{recordBookHash}/Completion/
DestinyApi getSpecialEventAdvisors GET /Destiny/Events/
DestinyApi getTriumphs GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Triumphs/
DestinyApi getUniqueWeaponHistory GET /Destiny/Stats/UniqueWeapons/{membershipType}/{destinyMembershipId}/{characterId}/
DestinyApi getVault GET /Destiny/{membershipType}/MyAccount/Vault/
DestinyApi getVaultSummary GET /Destiny/{membershipType}/MyAccount/Vault/Summary/
DestinyApi getVendorForCurrentCharacter GET /Destiny/{membershipType}/MyAccount/Character/{characterId}/Vendor/{vendorHash}/
DestinyApi getVendorForCurrentCharacterWithMetadata GET /Destiny/{membershipType}/MyAccount/Character/{characterId}/Vendor/{vendorHash}/Metadata/
DestinyApi getVendorItemDetailForCurrentCharacter GET /Destiny/{membershipType}/MyAccount/Character/{characterId}/Vendor/{vendorHash}/Item/{vendorItemId}/
DestinyApi getVendorItemDetailForCurrentCharacterWithMetadata GET /Destiny/{membershipType}/MyAccount/Character/{characterId}/Vendor/{vendorHash}/Item/{vendorItemId}/Metadata/
DestinyApi getVendorSummariesForCurrentCharacter GET /Destiny/{membershipType}/MyAccount/Character/{characterId}/Vendors/Summaries/
DestinyApi searchDestinyPlayer GET /Destiny/SearchDestinyPlayer/{membershipType}/{displayName}/
DestinyApi setItemLockState POST /Destiny/SetLockState/
DestinyApi setQuestTrackedState POST /Destiny/SetQuestTrackedState/
DestinyApi transferItem POST /Destiny/TransferItem/
UnofficialApi equipItem POST /Destiny/EquipItem/
UnofficialApi equipItems POST /Destiny/EquipItems/
UnofficialApi getAccount GET /Destiny/{membershipType}/Account/{destinyMembershipId}/
UnofficialApi getAccountSummary GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Summary/
UnofficialApi getActivityBlob GET /Destiny/Stats/ActivityBlob/{param1}/
UnofficialApi getActivityHistory GET /Destiny/Stats/ActivityHistory/{membershipType}/{destinyMembershipId}/{characterId}/
UnofficialApi getAdvisorsForAccount GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Advisors/
UnofficialApi getAdvisorsForCharacter GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Advisors/
UnofficialApi getAdvisorsForCharacterV2 GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Advisors/V2/
UnofficialApi getAdvisorsForCurrentCharacter GET /Destiny/{membershipType}/MyAccount/Character/{characterId}/Advisors/
UnofficialApi getAllItemsSummary GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Items/
UnofficialApi getAllVendorsForCurrentCharacter GET /Destiny/{membershipType}/MyAccount/Character/{characterId}/Vendors/
UnofficialApi getBondAdvisors GET /Destiny/{membershipType}/MyAccount/Advisors/Bonds/
UnofficialApi getCharacter GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Complete/
UnofficialApi getCharacterActivities GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Activities/
UnofficialApi getCharacterInventory GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Inventory/
UnofficialApi getCharacterInventorySummary GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Inventory/Summary/
UnofficialApi getCharacterProgression GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Progression/
UnofficialApi getCharacterSummary GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/
UnofficialApi getClanLeaderboards GET /Destiny/Stats/ClanLeaderboards/{clanId}/
UnofficialApi getDestinyAggregateActivityStats GET /Destiny/Stats/AggregateActivityStats/{membershipType}/{destinyMembershipId}/{characterId}/
UnofficialApi getDestinyExplorerItems GET /Destiny/Explorer/Items/
UnofficialApi getDestinyExplorerTalentNodeSteps GET /Destiny/Explorer/TalentNodeSteps/
UnofficialApi getDestinyLiveTileContentItems GET /Destiny/LiveTiles/
UnofficialApi getDestinyManifest GET /Destiny/Manifest/
UnofficialApi getDestinySingleDefinition GET /Destiny/Manifest/{definitionType}/{definitionId}/
UnofficialApi getExcellenceBadges GET /Destiny/Stats/GetExcellenceBadges/{membershipType}/{destinyMembershipId}/
UnofficialApi getGrimoireByMembership GET /Destiny/Vanguard/Grimoire/{membershipType}/{destinyMembershipId}/
UnofficialApi getGrimoireDefinition GET /Destiny/Vanguard/Grimoire/Definition/
UnofficialApi getHistoricalStats GET /Destiny/Stats/{membershipType}/{destinyMembershipId}/{characterId}/
UnofficialApi getHistoricalStatsDefinition GET /Destiny/Stats/Definition/
UnofficialApi getHistoricalStatsForAccount GET /Destiny/Stats/Account/{membershipType}/{destinyMembershipId}/
UnofficialApi getItemDetail GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Character/{characterId}/Inventory/{itemInstanceId}/
UnofficialApi getItemReferenceDetail GET /Destiny/{param1}/Account/{param2}/Character/{param3}/ItemReference/{param4}/
UnofficialApi getLeaderboards GET /Destiny/Stats/Leaderboards/{membershipType}/{destinyMembershipId}/
UnofficialApi getLeaderboardsForCharacter GET /Destiny/Stats/Leaderboards/{param1}/{param2}/{param3}/
UnofficialApi getLeaderboardsForPsn GET /Destiny/Stats/LeaderboardsForPsn/
UnofficialApi getMembershipIdByDisplayName GET /Destiny/{membershipType}/Stats/GetMembershipIdByDisplayName/{displayName}/
UnofficialApi getMyGrimoire GET /Destiny/Vanguard/Grimoire/{membershipType}/
UnofficialApi getPostGameCarnageReport GET /Destiny/Stats/PostGameCarnageReport/{activityInstanceId}/
UnofficialApi getPublicAdvisors GET /Destiny/Advisors/
UnofficialApi getPublicAdvisorsV2 GET /Destiny/Advisors/V2/
UnofficialApi getPublicVendor GET /Destiny/Vendors/{vendorHash}/
UnofficialApi getPublicVendorWithMetadata GET /Destiny/Vendors/{vendorHash}/Metadata/
UnofficialApi getPublicXurVendor GET /Destiny/Advisors/Xur/
UnofficialApi getRecordBookCompletionStatus GET /Destiny/{membershipType}/MyAccount/RecordBooks/{recordBookHash}/Completion/
UnofficialApi getSpecialEventAdvisors GET /Destiny/Events/
UnofficialApi getTriumphs GET /Destiny/{membershipType}/Account/{destinyMembershipId}/Triumphs/
UnofficialApi getUniqueWeaponHistory GET /Destiny/Stats/UniqueWeapons/{membershipType}/{destinyMembershipId}/{characterId}/
UnofficialApi getVault GET /Destiny/{membershipType}/MyAccount/Vault/
UnofficialApi getVaultSummary GET /Destiny/{membershipType}/MyAccount/Vault/Summary/
UnofficialApi getVendorForCurrentCharacter GET /Destiny/{membershipType}/MyAccount/Character/{characterId}/Vendor/{vendorHash}/
UnofficialApi getVendorForCurrentCharacterWithMetadata GET /Destiny/{membershipType}/MyAccount/Character/{characterId}/Vendor/{vendorHash}/Metadata/
UnofficialApi getVendorItemDetailForCurrentCharacter GET /Destiny/{membershipType}/MyAccount/Character/{characterId}/Vendor/{vendorHash}/Item/{vendorItemId}/
UnofficialApi getVendorItemDetailForCurrentCharacterWithMetadata GET /Destiny/{membershipType}/MyAccount/Character/{characterId}/Vendor/{vendorHash}/Item/{vendorItemId}/Metadata/
UnofficialApi getVendorSummariesForCurrentCharacter GET /Destiny/{membershipType}/MyAccount/Character/{characterId}/Vendors/Summaries/
UnofficialApi searchDestinyPlayer GET /Destiny/SearchDestinyPlayer/{membershipType}/{displayName}/
UnofficialApi setItemLockState POST /Destiny/SetLockState/
UnofficialApi setQuestTrackedState POST /Destiny/SetQuestTrackedState/
UnofficialApi transferItem POST /Destiny/TransferItem/

Documentation For Models

Documentation For Authorization

apiKey

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

oauth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://www.bungie.net/en/OAuth/Authorize
  • Scopes:
  • ReadBasicUserProfile: Read basic user profile information such as the user's handle, avatar icon, etc.
  • ReadGroups: Read Group/Clan Forums, Wall, and Members for groups and clans that the user has joined.
  • WriteGroups: Write Group/Clan Forums, Wall, and Members for groups and clans that the user has joined.
  • AdminGroups: Administer Group/Clan Forums, Wall, and Members for groups and clans that the user is a founder or an administrator.
  • BnetWrite: Create new groups, clans, and forum posts.
  • MoveEquipDestinyItems: Move or equip Destiny items
  • ReadDestinyInventoryAndVault: Read Destiny 1 Inventory and Vault contents. For Destiny 2, this scope is needed to read anything regarded as private. This is the only scope a Destiny 2 app needs for read operations against Destiny 2 data such as inventory, vault, currency, vendors, milestones, progression, etc.
  • ReadUserData: Read user data such as who they are web notifications, clan/group memberships, recent activity, muted users.
  • EditUserData: Edit user data such as preferred language, status, motto, avatar selection and theme.
  • ReadDestinyVendorsAndAdvisors: Access vendor and advisor data specific to a user. OBSOLETE. This scope is only used on the Destiny 1 API.
  • ReadAndApplyTokens: Read offer history and claim and apply tokens for the user.
  • AdvancedWriteActions: Can perform actions that will result in a prompt to the user via the Destiny app.

Author

lowlines89@gmail.com